capacitor-native-downloader

native file downloader

Install

npm install capacitor-native-downloader
npx cap sync

API

• echo(...)
• add(...)
• start(...)
• pause(...)
• resume(...)
• cancel(...)
• Interfaces

echo(...)

echo(options: { value: string; }) => any

| Param | Type | | ------------- | ------------------------------- | | options | { value: string; } |

Returns: any

add(...)

add(options: { params: IAddDownloadRequest; }) => any

| Param | Type | | ------------- | -------------------------------------------------------------------------------- | | options | { params: IAddDownloadRequest; } |

Returns: any

start(...)

start(options: { params: IStartDownloadRequest; }) => any

| Param | Type | | ------------- | ------------------------------------------------------------------------------------ | | options | { params: IStartDownloadRequest; } |

Returns: any

pause(...)

pause(options: { params: IPauseDownloadRequest; }) => any

| Param | Type | | ------------- | ------------------------------------------------------------------------------------ | | options | { params: IPauseDownloadRequest; } |

Returns: any

resume(...)

resume(options: { params: IResumeDownloadRequest; }) => any

| Param | Type | | ------------- | -------------------------------------------------------------------------------------- | | options | { params: IResumeDownloadRequest; } |

Returns: any

cancel(...)

cancel(options: { params: ICancelDownloadRequest; }) => any

| Param | Type | | ------------- | -------------------------------------------------------------------------------------- | | options | { params: ICancelDownloadRequest; } |

Returns: any

Interfaces

IAddDownloadRequest

| Prop | Type | | ----------------- | --------------------------------------- | | id | string | | url | string | | size | number | | filePath | string | | fileName | string | | displayName | string | | headers | { authorization: string; } |

IAddDownloadResponse

| Prop | Type | | ------------------ | ------------------- | | id | string | | fileName | string | | absolutePath | string |

IStartDownloadRequest

| Prop | Type | | -------- | ------------------- | | id | string |

IStartDownloadResponse

| Prop | Type | | ------------------ | ------------------- | | id | string | | filename | string | | absolutePath | string |

IPauseDownloadRequest

| Prop | Type | | -------- | ------------------- | | id | string |

IPauseDownloadResponse

| Prop | Type | | ------------------ | ------------------- | | id | string | | filename | string | | absolutePath | string |

IResumeDownloadRequest

| Prop | Type | | -------- | ------------------- | | id | string |

IResumeDownloadResponse

| Prop | Type | | ------------------ | ------------------- | | id | string | | filename | string | | absolutePath | string |

ICancelDownloadRequest

| Prop | Type | | -------- | ------------------- | | id | string |

ICancelDownloadResponse

| Prop | Type | | ------------------ | ------------------- | | id | string | | filename | string | | absolutePath | string |