capacitor-icloud-documents

Capacitor iCloud Documents

Install

npm install capacitor-icloud-documents
npx cap sync

API

• echo(...)
• readFile(...)
• readFileB64(...)
• removeFile(...)
• writeFile(...)
• mkdir(...)
• stat(...)
• fileExist(...)
• readdir(...)
• initUbiquitousContainer()
• syncToCloud(...)

echo(...)

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

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

Returns: Promise<{ value: string; }>

readFile(...)

readFile(options: { filePath: string; }) => Promise<{ fileStream: string; }>

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

Returns: Promise<{ fileStream: string; }>

readFileB64(...)

readFileB64(options: { filePath: string; }) => Promise<{ fileStream: string; }>

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

Returns: Promise<{ fileStream: string; }>

removeFile(...)

removeFile(options: { filePath: string; }) => Promise<{ result: string; url: string; }>

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

Returns: Promise<{ result: string; url: string; }>

writeFile(...)

writeFile(options: { filePath: string; data: string; overwrite?: boolean; }) => Promise<{ result: string; url: string; }>

| Param | Type | | ------------- | --------------------------------------------------------------------- | | options | { filePath: string; data: string; overwrite?: boolean; } |

Returns: Promise<{ result: string; url: string; }>

mkdir(...)

mkdir(options: { path: string; }) => Promise<{ result: string; url: string; }>

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

Returns: Promise<{ result: string; url: string; }>

stat(...)

stat(options: { path: string; }) => Promise<{ type: 'Directory' | 'File'; size: number; modificationDate: string; creationDate: string; }>

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

Returns: Promise<{ type: 'Directory' | 'File'; size: number; modificationDate: string; creationDate: string; }>

fileExist(...)

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

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

Returns: Promise<{ result: boolean; }>

readdir(...)

readdir(options: { path: string; }) => Promise<{ result: string[]; }>

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

Returns: Promise<{ result: string[]; }>

initUbiquitousContainer()

initUbiquitousContainer() => Promise<void>

syncToCloud(...)

syncToCloud(options: { filePath: string; destinationFolder: string; }) => Promise<{ url: string; }>

| Param | Type | | ------------- | ------------------------------------------------------------- | | options | { filePath: string; destinationFolder: string; } |

Returns: Promise<{ url: string; }>