useFileSystemAccess
Create and read and write local files with FileSystemAccessAPI
Demo
DataType
isSupported: false
fileName: ''
fileMIME: ''
fileSize: 0
fileLastModified: 0
Usage
import { useFileSystemAccess } from '@vueuse/core'
const { isSupported, data, file, fileName, fileMIME, fileSize, fileLastModified, create, open, save, saveAs, updateData } = useFileSystemAccess()
import { useFileSystemAccess } from '@vueuse/core'
const { isSupported, data, file, fileName, fileMIME, fileSize, fileLastModified, create, open, save, saveAs, updateData } = useFileSystemAccess()
Type Declarations
Show Type Declarations
/**
* window.showOpenFilePicker parameters
* @see https://developer.mozilla.org/en-US/docs/Web/API/window/showOpenFilePicker#parameters
*/
export interface FileSystemAccessShowOpenFileOptions {
multiple?: boolean
types?: Array<{
description?: string
accept: Record<string, string[]>
}>
excludeAcceptAllOption?: boolean
}
/**
* window.showSaveFilePicker parameters
* @see https://developer.mozilla.org/en-US/docs/Web/API/window/showSaveFilePicker#parameters
*/
export interface FileSystemAccessShowSaveFileOptions {
suggestedName?: string
types?: Array<{
description?: string
accept: Record<string, string[]>
}>
excludeAcceptAllOption?: boolean
}
/**
* FileHandle
* @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemFileHandle
*/
export interface FileSystemFileHandle {
getFile: () => Promise<File>
createWritable: () => FileSystemWritableFileStream
}
/**
* @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemWritableFileStream
*/
interface FileSystemWritableFileStream extends WritableStream {
/**
* @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemWritableFileStream/write
*/
write: FileSystemWritableFileStreamWrite
/**
* @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemWritableFileStream/seek
*/
seek: (position: number) => Promise<void>
/**
* @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemWritableFileStream/truncate
*/
truncate: (size: number) => Promise<void>
}
/**
* FileStream.write
* @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemWritableFileStream/write
*/
interface FileSystemWritableFileStreamWrite {
(data: string | BufferSource | Blob): Promise<void>
(options: {
type: "write"
position: number
data: string | BufferSource | Blob
}): Promise<void>
(options: { type: "seek"; position: number }): Promise<void>
(options: { type: "truncate"; size: number }): Promise<void>
}
/**
* FileStream.write
* @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemWritableFileStream/write
*/
export declare type FileSystemAccessWindow = Window & {
showSaveFilePicker: (
options: FileSystemAccessShowSaveFileOptions
) => Promise<FileSystemFileHandle>
showOpenFilePicker: (
options: FileSystemAccessShowOpenFileOptions
) => Promise<FileSystemFileHandle[]>
}
export declare type UseFileSystemAccessCommonOptions = Pick<
FileSystemAccessShowOpenFileOptions,
"types" | "excludeAcceptAllOption"
>
export declare type UseFileSystemAccessShowSaveFileOptions = Pick<
FileSystemAccessShowSaveFileOptions,
"suggestedName"
>
export declare type UseFileSystemAccessOptions = ConfigurableWindow &
UseFileSystemAccessCommonOptions & {
/**
* file data type
*/
dataType?: MaybeRef<"Text" | "ArrayBuffer" | "Blob">
}
/**
* Create and read and write local files.
* @see https://vueuse.org/useFileSystemAccess
* @param options
*/
export declare function useFileSystemAccess(
options: UseFileSystemAccessOptions & {
dataType: "Text"
}
): UseFileSystemAccessReturn<string>
export declare function useFileSystemAccess(
options: UseFileSystemAccessOptions & {
dataType: "ArrayBuffer"
}
): UseFileSystemAccessReturn<ArrayBuffer>
export declare function useFileSystemAccess(
options: UseFileSystemAccessOptions & {
dataType: "Blob"
}
): UseFileSystemAccessReturn<Blob>
export declare function useFileSystemAccess(
options: UseFileSystemAccessOptions
): UseFileSystemAccessReturn<string | ArrayBuffer | Blob>
export interface UseFileSystemAccessReturn<T = string> {
isSupported: boolean
data: Ref<T | undefined>
file: Ref<File | undefined>
fileName: Ref<string>
fileMIME: Ref<string>
fileSize: Ref<number>
fileLastModified: Ref<number>
open: (_options?: UseFileSystemAccessCommonOptions) => Awaitable<void>
create: (_options?: UseFileSystemAccessShowSaveFileOptions) => Awaitable<void>
save: (_options?: UseFileSystemAccessShowSaveFileOptions) => Awaitable<void>
saveAs: (_options?: UseFileSystemAccessShowSaveFileOptions) => Awaitable<void>
updateData: () => Awaitable<void>
}
/**
* window.showOpenFilePicker parameters
* @see https://developer.mozilla.org/en-US/docs/Web/API/window/showOpenFilePicker#parameters
*/
export interface FileSystemAccessShowOpenFileOptions {
multiple?: boolean
types?: Array<{
description?: string
accept: Record<string, string[]>
}>
excludeAcceptAllOption?: boolean
}
/**
* window.showSaveFilePicker parameters
* @see https://developer.mozilla.org/en-US/docs/Web/API/window/showSaveFilePicker#parameters
*/
export interface FileSystemAccessShowSaveFileOptions {
suggestedName?: string
types?: Array<{
description?: string
accept: Record<string, string[]>
}>
excludeAcceptAllOption?: boolean
}
/**
* FileHandle
* @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemFileHandle
*/
export interface FileSystemFileHandle {
getFile: () => Promise<File>
createWritable: () => FileSystemWritableFileStream
}
/**
* @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemWritableFileStream
*/
interface FileSystemWritableFileStream extends WritableStream {
/**
* @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemWritableFileStream/write
*/
write: FileSystemWritableFileStreamWrite
/**
* @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemWritableFileStream/seek
*/
seek: (position: number) => Promise<void>
/**
* @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemWritableFileStream/truncate
*/
truncate: (size: number) => Promise<void>
}
/**
* FileStream.write
* @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemWritableFileStream/write
*/
interface FileSystemWritableFileStreamWrite {
(data: string | BufferSource | Blob): Promise<void>
(options: {
type: "write"
position: number
data: string | BufferSource | Blob
}): Promise<void>
(options: { type: "seek"; position: number }): Promise<void>
(options: { type: "truncate"; size: number }): Promise<void>
}
/**
* FileStream.write
* @see https://developer.mozilla.org/en-US/docs/Web/API/FileSystemWritableFileStream/write
*/
export declare type FileSystemAccessWindow = Window & {
showSaveFilePicker: (
options: FileSystemAccessShowSaveFileOptions
) => Promise<FileSystemFileHandle>
showOpenFilePicker: (
options: FileSystemAccessShowOpenFileOptions
) => Promise<FileSystemFileHandle[]>
}
export declare type UseFileSystemAccessCommonOptions = Pick<
FileSystemAccessShowOpenFileOptions,
"types" | "excludeAcceptAllOption"
>
export declare type UseFileSystemAccessShowSaveFileOptions = Pick<
FileSystemAccessShowSaveFileOptions,
"suggestedName"
>
export declare type UseFileSystemAccessOptions = ConfigurableWindow &
UseFileSystemAccessCommonOptions & {
/**
* file data type
*/
dataType?: MaybeRef<"Text" | "ArrayBuffer" | "Blob">
}
/**
* Create and read and write local files.
* @see https://vueuse.org/useFileSystemAccess
* @param options
*/
export declare function useFileSystemAccess(
options: UseFileSystemAccessOptions & {
dataType: "Text"
}
): UseFileSystemAccessReturn<string>
export declare function useFileSystemAccess(
options: UseFileSystemAccessOptions & {
dataType: "ArrayBuffer"
}
): UseFileSystemAccessReturn<ArrayBuffer>
export declare function useFileSystemAccess(
options: UseFileSystemAccessOptions & {
dataType: "Blob"
}
): UseFileSystemAccessReturn<Blob>
export declare function useFileSystemAccess(
options: UseFileSystemAccessOptions
): UseFileSystemAccessReturn<string | ArrayBuffer | Blob>
export interface UseFileSystemAccessReturn<T = string> {
isSupported: boolean
data: Ref<T | undefined>
file: Ref<File | undefined>
fileName: Ref<string>
fileMIME: Ref<string>
fileSize: Ref<number>
fileLastModified: Ref<number>
open: (_options?: UseFileSystemAccessCommonOptions) => Awaitable<void>
create: (_options?: UseFileSystemAccessShowSaveFileOptions) => Awaitable<void>
save: (_options?: UseFileSystemAccessShowSaveFileOptions) => Awaitable<void>
saveAs: (_options?: UseFileSystemAccessShowSaveFileOptions) => Awaitable<void>
updateData: () => Awaitable<void>
}
Source
Contributors
Carlos Gamez
wheat
Jelf