Class OPFSFileSystemProvider

Subtype of FileSystemProvider that ensures that the optional functions, needed for providers that should be able to read & write files, are implemented.

Implements

FileSystemProviderWithFileReadWriteCapability

Index

Constructors

constructor

new OPFSFileSystemProvider(): OPFSFileSystemProvider
Returns OPFSFileSystemProvider

Properties

capabilities

capabilities: FileSystemProviderCapabilities = FileSystemProviderCapabilities.FileReadWrite

The FileSystemProviderCapabilities for this provider.

`Private` directoryHandle

directoryHandle: FileSystemDirectoryHandle

`Protected` `Readonly` initialization

initialization: OPFSInitialization

`Private` initialized

initialized: Promise<true>

onDidChangeCapabilities

onDidChangeCapabilities: Event<void> = Event.None

Event that is fired if the capabilities of this provider have changed.

`Readonly` onDidChangeFile

onDidChangeFile: Event<readonly FileChange[]> = ...

Event that is fired if a (watched) file in the filesystem of this provider has changed.

`Private` `Readonly` onDidChangeFileEmitter

onDidChangeFileEmitter: Emitter<readonly FileChange[]> = ...

onFileWatchError

onFileWatchError: Event<void> = Event.None

Event that is fired if an error occurred when watching files in the filesystem of this provider.

Methods

delete

delete(resource, _opts): Promise<void>
Delete the given resource.
Parameters
- resource: URI
  The URI of the resource to delete.
- _opts: FileDeleteOptions
  Options to define if files should be deleted recursively and if the trash should be used.
Returns Promise<void>
Implementation of FileSystemProviderWithFileReadWriteCapability.delete
- Defined in packages/filesystem/src/browser-only/opfs-filesystem-provider.ts:147

exists

exists(resource): Promise<boolean>
Parameters
- resource: URI
Returns Promise<boolean>
- Defined in packages/filesystem/src/browser-only/opfs-filesystem-provider.ts:71

`Protected` init

init(): void
Returns void
- Defined in packages/filesystem/src/browser-only/opfs-filesystem-provider.ts:51

mkdir

mkdir(resource): Promise<void>
Create a new directory using the given resource uri.
Parameters
- resource: URI
  The URI of the new folder.
Returns Promise<void>
Implementation of FileSystemProviderWithFileReadWriteCapability.mkdir
- Defined in packages/filesystem/src/browser-only/opfs-filesystem-provider.ts:112

readFile

readFile(resource): Promise<Uint8Array>
Read the contents of the given file as stream.
Parameters
- resource: URI
  The URI of the file.
Returns Promise<Uint8Array>
The ReadableStreamEvents for the readable stream of the given file.
Implementation of FileSystemProviderWithFileReadWriteCapability.readFile
- Defined in packages/filesystem/src/browser-only/opfs-filesystem-provider.ts:190

readdir

readdir(resource): Promise<[string, FileType][]>
Retrieve the content of a given directory.
Parameters
- resource: URI
  The URI of the directory.
Returns Promise<[string, FileType][]>
A map containing the FileType for each child resource, identified by name.
Implementation of FileSystemProviderWithFileReadWriteCapability.readdir
- Defined in packages/filesystem/src/browser-only/opfs-filesystem-provider.ts:122

rename

rename(from, to, opts): Promise<void>
Rename a file or folder.
Parameters
- from: URI
  URI of the existing file or folder.
- to: URI
  URI of the target location.
- opts: FileOverwriteOptions
  Options to define if existing files should be overwritten.
Returns Promise<void>
Implementation of FileSystemProviderWithFileReadWriteCapability.rename
- Defined in packages/filesystem/src/browser-only/opfs-filesystem-provider.ts:164

stat

stat(resource): Promise<Stat>
Retrieve metadata about a given file.
Parameters
- resource: URI
Returns Promise<Stat>
A promise of the metadata about the resource.
Implementation of FileSystemProviderWithFileReadWriteCapability.stat
- Defined in packages/filesystem/src/browser-only/opfs-filesystem-provider.ts:81

`Private` toFileSystemHandle

toFileSystemHandle(resource, options?): Promise<FileSystemHandle>
Returns the FileSystemHandle for the given resource given by a URI.
Parameters
- resource: URI
  URI/path of the resource
- Optional options: CreateFileSystemHandleOptions
  Options for the creation of the handle while traversing the path
Returns Promise<FileSystemHandle>
FileSystemHandle for the given resource
- Defined in packages/filesystem/src/browser-only/opfs-filesystem-provider.ts:250

watch

watch(_resource, _opts): Disposable
Watch the given resource and react to changes by firing the FileSystemProvider#onDidChangeFile event.
Parameters
- _resource: URI
  URI of the resource to be watched.
- _opts: WatchOptions
  Options to define if the resource should be watched recursively and to provide a set of resources that should be excluded from watching.
Returns Disposable
A Disposable that can be invoked to stop watching the resource.
Implementation of FileSystemProviderWithFileReadWriteCapability.watch
- Defined in packages/filesystem/src/browser-only/opfs-filesystem-provider.ts:67

writeFile

writeFile(resource, content, opts): Promise<void>
Write data to a file, replacing its entire contents.
Parameters
- resource: URI
  The uri of the file.
- content: Uint8Array
  The new content of the file.
- opts: FileWriteOptions
  Options to define if the file should be created if missing and if an existing file should be overwritten.
Returns Promise<void>
Implementation of FileSystemProviderWithFileReadWriteCapability.writeFile
- Defined in packages/filesystem/src/browser-only/opfs-filesystem-provider.ts:208

Class OPFSFileSystemProvider

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns OPFSFileSystemProvider

Properties

capabilities

Private directoryHandle

Protected Readonly initialization

Private initialized

onDidChangeCapabilities

Readonly onDidChangeFile

Private Readonly onDidChangeFileEmitter

onFileWatchError

Methods

delete

Parameters

Returns Promise<void>

exists

Parameters

Returns Promise<boolean>

Protected init

Returns void

mkdir

Parameters

Returns Promise<void>

readFile

Parameters

Returns Promise<Uint8Array>

readdir

Parameters

Returns Promise<[string, FileType][]>

rename

Parameters

Returns Promise<void>

stat

Parameters

Returns Promise<Stat>

Private toFileSystemHandle

Parameters

Returns Promise<FileSystemHandle>

watch

Parameters

Returns Disposable

writeFile

Parameters

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Private` directoryHandle

`Protected` `Readonly` initialization

`Private` initialized

`Readonly` onDidChangeFile

`Private` `Readonly` onDidChangeFileEmitter

`Protected` init

`Private` toFileSystemHandle