Class BrowserOnlyPluginFileSystemProvider

Reads the plugin assets the build dropped under PLUGINS_BASE_PATH. With a backend those come off its disk via file:; browser-only has to fetch them over HTTP.

Read-only, and only for what goes through the FileService: color themes, icon themes, icon fonts.

Implements

FileSystemProvider

Index

Constructors

constructor

new BrowserOnlyPluginFileSystemProvider(): BrowserOnlyPluginFileSystemProvider
Returns BrowserOnlyPluginFileSystemProvider

Properties

`Readonly`capabilities

capabilities: number = ...

The FileSystemProviderCapabilities for this provider.

`Readonly`onDidChangeCapabilities

onDidChangeCapabilities: Event<any> = 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.

`Protected` `Readonly`onDidChangeFileEmitter

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

`Readonly`onFileWatchError

onFileWatchError: Event<any> = Event.None

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

Methods

delete

delete(resource: URI, opts: FileDeleteOptions): 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 FileSystemProvider.delete
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-file-system-provider.ts:107

`Protected`fetch

fetch(resource: URI, method: "GET" | "HEAD"): Promise<Response>
Parameters
- resource: URI
- method: "GET" | "HEAD"
Returns Promise<Response>
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-file-system-provider.ts:81

mkdir

mkdir(resource: URI): 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 FileSystemProvider.mkdir
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-file-system-provider.ts:103

readdir

readdir(resource: URI): 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 FileSystemProvider.readdir
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-file-system-provider.ts:99

readFile

readFile(resource: URI): Promise<Uint8Array<ArrayBufferLike>>
Optional function that has to be implemented by FileSystemProviderWithFileReadWriteCapability. See FileSystemProviderWithFileReadWriteCapability#readFile for additional documentation.
Parameters
- resource: URI
Returns Promise<Uint8Array<ArrayBufferLike>>
Implementation of FileSystemProvider.readFile
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-file-system-provider.ts:66

rename

rename(from: URI, to: URI, opts: FileOverwriteOptions): 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 FileSystemProvider.rename
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-file-system-provider.ts:111

stat

stat(resource: URI): Promise<Stat>
Retrieve metadata about a given file.
Parameters
- resource: URI
Returns Promise<Stat>
A promise of the metadata about the resource.
Implementation of FileSystemProvider.stat
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-file-system-provider.ts:50

`Protected`toUrl

toUrl(resource: URI): string
Maps the URI back to the path the build actually wrote, built through Endpoint so this still works when the application is deployed under a sub-path. URI.path is decoded, so it has to be re-encoded - otherwise a # or ? in an asset name would be read as a fragment or query.
Parameters
- resource: URI
Returns string
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-file-system-provider.ts:77

watch

watch(resource: URI, opts: WatchOptions): 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 FileSystemProvider.watch
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-file-system-provider.ts:45

writeFile

writeFile(
    resource: URI,
    content: Uint8Array,
    opts: FileWriteOptions,
): Promise<void>
Optional function that has to be implemented by FileSystemProviderWithFileReadWriteCapability. See FileSystemProviderWithFileReadWriteCapability#writeFile for additional documentation.
Parameters
- resource: URI
- content: Uint8Array
- opts: FileWriteOptions
Returns Promise<void>
Implementation of FileSystemProvider.writeFile
- Defined in packages/plugin-ext/src/hosted/browser-only/browser-only-plugin-file-system-provider.ts:115

Class BrowserOnlyPluginFileSystemProvider

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Returns BrowserOnlyPluginFileSystemProvider

Properties

Readonlycapabilities

ReadonlyonDidChangeCapabilities

ReadonlyonDidChangeFile

Protected ReadonlyonDidChangeFileEmitter

ReadonlyonFileWatchError

Methods

delete

Parameters

Returns Promise<void>

Protectedfetch

Parameters

Returns Promise<Response>

mkdir

Parameters

Returns Promise<void>

readdir

Parameters

Returns Promise<[string, FileType][]>

readFile

Parameters

Returns Promise<Uint8Array<ArrayBufferLike>>

rename

Parameters

Returns Promise<void>

stat

Parameters

Returns Promise<Stat>

ProtectedtoUrl

Parameters

Returns string

watch

Parameters

Returns Disposable

writeFile

Parameters

Returns Promise<void>

Settings

On This Page

`Readonly`capabilities

`Readonly`onDidChangeCapabilities

`Readonly`onDidChangeFile

`Protected` `Readonly`onDidChangeFileEmitter

`Readonly`onFileWatchError

`Protected`fetch

`Protected`toUrl