useFileSystemAccess

v0.0.15testeddemo

Create, read, and write local files via the File System Access API.

Examples

const { isSupported, data, open, save } = useFileSystemAccess({ dataType: 'Text' });
await open();
data.value += '\nappended';
await save();

// Read raw bytes
const { data } = useFileSystemAccess({ dataType: 'ArrayBuffer' });

Demo

Loading demo…

Signatures

export function useFileSystemAccess(): UseFileSystemAccessReturn<string | ArrayBuffer | Blob>;

export function useFileSystemAccess(options: UseFileSystemAccessOptions & { dataType: 'Text' }): UseFileSystemAccessReturn<string>;

export function useFileSystemAccess(options: UseFileSystemAccessOptions & { dataType: 'ArrayBuffer' }): UseFileSystemAccessReturn<ArrayBuffer>;

export function useFileSystemAccess(options: UseFileSystemAccessOptions & { dataType: 'Blob' }): UseFileSystemAccessReturn<Blob>;

export function useFileSystemAccess(options: UseFileSystemAccessOptions): UseFileSystemAccessReturn<string | ArrayBuffer | Blob>;

Parameters

Parameter	Type	Default	Description
`options`?	`any`	`{}`	Options including `dataType`, `types`, `excludeAcceptAllOption`, and `onError`

Returns

UseFileSystemAccessReturn<string | ArrayBuffer | Blob>`isSupported`, `data`, `file`, `fileName`, `fileMIME`, `fileSize`, `fileLastModified`, `open`, `create`, `save`, `saveAs`, `updateData`