nativescript-download-progress

Introduction

This plugin allows you to download large files and provides progress updates.

Nativescripts http.getFile method stores the data in memory which can cause out of memory exceptions and doesn't provide progress updates.

Installation

tns plugin add nativescript-download-progress

Examples

import { DownloadProgress } from "nativescript-download-progress"

const dp = new DownloadProgress();
dp.on('started', ({ contentLength }) => console.log('started', contentLength));
dp.on('progress', ({ progress, url, destinationPath }) => console.log(progress, url, destinationPath));
dp.on('finished', ({ file }) => console.log('finished', file.path));
dp.download({ url: 'http://ipv4.download.thinkbroadband.com/20MB.zip' }).then(file => {
  console.log('Success', file);
}).catch(error => {
  console.log('Error', error);
});

Passing request headers

import { DownloadProgress } from "nativescript-download-progress"

const dp = new DownloadProgress();
dp.on('started', ({ contentLength }) => console.log('started', contentLength));
dp.on('progress', ({ progress, url, destinationPath }) => console.log(progress, url, destinationPath));
dp.on('finished', ({ file }) => console.log('finished', file.path));
const opts = {
  url: 'http://ipv4.download.thinkbroadband.com/20MB.zip',
  destinationPath: 'some/path/to/file.zip',
  request: {
    method: 'GET',
    headers: {
      Authorization: 'Bearer token',
    }
  }
};
dp.download(opts).then(file => {
  console.log('Success', file);
}).catch(error => {
  console.log('Error', error);
});

Async / Await

import { DownloadProgress } from "nativescript-download-progress"

const dp = new DownloadProgress();
dp.on('started', ({ contentLength }) => console.log('started', contentLength));
dp.on('progress', ({ progress, url, destinationPath }) => console.log(progress, url, destinationPath));
dp.on('finished', ({ file }) => console.log('finished', file.path));
try {
  const f = await dp.download({ url: 'http://ipv4.download.thinkbroadband.com/20MB.zip' });
  console.log(f.path);
} catch (error) {
  console.log('Error', error);
}

License

Apache License Version 2.0, January 2004