@capgo/capacitor-downloader v0.0.12

@capgo/capacitor-downloader

Download file in background or foreground

WIP: the plugin is not yet ready for production

Install

npm install @capgo/capacitor-downloader
npx cap sync

API

• download(...)
• pause(...)
• resume(...)
• stop(...)
• checkStatus(...)
• getFileInfo(...)
• addListener('downloadProgress', ...)
• addListener('downloadCompleted', ...)
• addListener('downloadFailed', ...)
• removeAllListeners()
• Interfaces

download(...)

download(options: DownloadOptions) => any

Returns: any

pause(...)

pause(id: string) => any

Returns: any

resume(...)

resume(id: string) => any

Returns: any

stop(...)

stop(id: string) => any

Returns: any

checkStatus(...)

checkStatus(id: string) => any

Returns: any

getFileInfo(...)

getFileInfo(path: string) => any

Returns: any

addListener('downloadProgress', ...)

addListener(eventName: 'downloadProgress', listenerFunc: (progress: { id: string; progress: number; }) => void) => any

Returns: any

addListener('downloadCompleted', ...)

addListener(eventName: 'downloadCompleted', listenerFunc: (result: { id: string; }) => void) => any

Returns: any

addListener('downloadFailed', ...)

addListener(eventName: 'downloadFailed', listenerFunc: (error: { id: string; error: string; }) => void) => any

Returns: any

removeAllListeners()

removeAllListeners() => any

Returns: any

Interfaces

DownloadOptions

DownloadTask

PluginListenerHandle

Credit

This plugin was inspired from: https://github.com/kesha-antonov/react-native-background-downloader