capacitor-downloader
TypeScript icon, indicating that this package has built-in type declarations

2.1.0 • Public • Published

Capacitor Downloader

npm npm Build Status

Installation

  • npm i capacitor-downloader

Usage

import { Downloader } from 'capacitor-downloader';
const downloader = new Downloader();
const data = await downloader.createDownload({
  url:
    'https://wallpaperscraft.com/image/hulk_wolverine_x_men_marvel_comics_art_99032_3840x2400.jpg'
});
const imageDownloaderId = data.value;
downloader
  .start({id:imageDownloaderId}, (progressData: ProgressEventData) => {
    console.log(`Progress : ${progressData.value}%`);
    console.log(`Current Size : ${progressData.currentSize}%`);
    console.log(`Total Size : ${progressData.totalSize}%`);
    console.log(`Download Speed in bytes : ${progressData.speed}%`);
  })
  .then((completed: DownloadEventData) => {
    console.log(`Image : ${completed.path}`);
  })
  .catch(error => {
    console.log(error.message);
  });

Api

Method Default Type Description
createDownload(options: DownloadOptions) Promise<Options> Creates a download task it returns the id of the task
getStatus(options:Options) Promise<StatusCode> Gets the status of a download task.
start(options:Options, progress?: Function) Promise<DownloadEventData> Starts a download task.
resume(options:Options) Promise<void> Resumes a download task.
cancel(options:Options) Promise<void> Cancels a download task.
pause(options:Options) Promise<void> Pauses a download task.
getPath(options:Options) Promise<void> Return the path of a download task.

Example Image

IOS Android
Coming Soon Coming Soon

TODO

  • Local Notifications

Readme

Keywords

Package Sidebar

Install

npm i capacitor-downloader

Weekly Downloads

42

Version

2.1.0

License

MIT

Unpacked Size

185 kB

Total Files

54

Last publish

Collaborators

  • triniwiz