@mycapacitor-plugin/file-system

File system

Install

npm install @mycapacitor-plugin/file-system
npx cap sync

API

• length(...)
• delete(...)
• download(...)
• addListener('onProgressChange', ...)
• Interfaces
• Type Aliases

length(...)

length(path: string) => Promise<{ length: number; }>

| Param | Type | | ---------- | ------------------- | | path | string |

Returns: Promise<{ length: number; }>

delete(...)

delete(path: string) => Promise<{ result: boolean; }>

| Param | Type | | ---------- | ------------------- | | path | string |

Returns: Promise<{ result: boolean; }>

download(...)

download(url: string, progress: boolean) => Promise<{ downloadFilePath: string; }>

| Param | Type | | -------------- | -------------------- | | url | string | | progress | boolean |

Returns: Promise<{ downloadFilePath: string; }>

addListener('onProgressChange', ...)

addListener(eventName: 'onProgressChange', listenerFunc: ProgressChangeListener) => Promise<PluginListenerHandle>

| Param | Type | | ------------------ | ------------------------------------------------------------------------- | | eventName | 'onProgressChange' | | listenerFunc | ProgressChangeListener |

Returns: Promise<PluginListenerHandle>

Interfaces

PluginListenerHandle

| Prop | Type | | ------------ | ----------------------------------------- | | remove | () => Promise<void> |

DownloadProgressInfo

| Prop | Type | | ------------------- | -------------------- | | currentLength | number | | totalLength | number | | success | boolean | | finished | boolean |

Type Aliases

ProgressChangeListener

(progress: DownloadProgressInfo): void