Class DelegatingFileSystemProvider

constructor

• new DelegatingFileSystemProvider(delegate, options, toDispose?): DelegatingFileSystemProvider

• Parameters

  • delegate: FileSystemProvider
  • options: filesystem.Options
  • toDispose: DisposableCollection = ...

  Returns DelegatingFileSystemProvider

Readonly onDidChangeFile

Readonly onFileWatchError

capabilities

• get capabilities(): FileSystemProviderCapabilities

• Returns FileSystemProviderCapabilities

onDidChangeCapabilities

• get onDidChangeCapabilities(): Event<void>

• Returns Event<void>

access

• access(resource, mode?): Promise<void>

• Parameters

  • resource: URI
  • Optional mode: number

  Returns Promise<void>

close

• close(fd): Promise<void>

• Parameters

  • fd: number

  Returns Promise<void>

copy

• copy(from, to, opts): Promise<void>

• Parameters

  • from: URI
  • to: URI
  • opts: FileOverwriteOptions

  Returns Promise<void>

delete

• delete(resource, opts): Promise<void>

• Parameters

  • resource: URI
  • opts: FileDeleteOptions

  Returns Promise<void>

dispose

• dispose(): void

• Returns void

fromUnderlyingResource

• fromUnderlyingResource(resource): undefined | URI

• Converts from an underlying fs provider resource format.

  For example converting file resources under a user home to user-storage resource:

  • file://home/.theia/settings.json => user-storage:/user/settings.json
  • file://documents/some-document.txt => undefined

  Parameters

  • resource: URI

  Returns undefined | URI

fsPath

• fsPath(resource): Promise<string>

• Parameters

  • resource: URI

  Returns Promise<string>

mkdir

• mkdir(resource): Promise<void>

• Parameters

  • resource: URI

  Returns Promise<void>

open

• open(resource, opts): Promise<number>

• Parameters

  • resource: URI
  • opts: FileOpenOptions

  Returns Promise<number>

read

• read(fd, pos, data, offset, length): Promise<number>

• Parameters

  • fd: number
  • pos: number
  • data: Uint8Array
  • offset: number
  • length: number

  Returns Promise<number>

readFile

• readFile(resource): Promise<Uint8Array>

• Parameters

  • resource: URI

  Returns Promise<Uint8Array>

readFileStream

• readFileStream(resource, opts, token): ReadableStreamEvents<Uint8Array>

• Parameters

  • resource: URI
  • opts: FileReadStreamOptions
  • token: CancellationToken

  Returns ReadableStreamEvents<Uint8Array>

readdir

• readdir(resource): Promise<[string, FileType][]>

• Parameters

  • resource: URI

  Returns Promise<[string, FileType][]>

rename

• rename(from, to, opts): Promise<void>

• Parameters

  • from: URI
  • to: URI
  • opts: FileOverwriteOptions

  Returns Promise<void>

stat

• stat(resource): Promise<Stat>

• Parameters

  • resource: URI

  Returns Promise<Stat>

toUnderlyingResource

• toUnderlyingResource(resource): URI

• Converts to an underlying fs provider resource format.

  For example converting user-storage resources to file resources under a user home: user-storage:/user/settings.json => file://home/.theia/settings.json

  Parameters

  • resource: URI

  Returns URI

updateFile

• updateFile(resource, changes, opts): Promise<FileUpdateResult>

• Parameters

  • resource: URI
  • changes: TextDocumentContentChangeEvent[]
  • opts: FileUpdateOptions

  Returns Promise<FileUpdateResult>

watch

• watch(resource, opts): Disposable

• Parameters

  • resource: URI
  • opts: WatchOptions

  Returns Disposable

write

• write(fd, pos, data, offset, length): Promise<number>

• Parameters

  • fd: number
  • pos: number
  • data: Uint8Array
  • offset: number
  • length: number

  Returns Promise<number>

writeFile

• writeFile(resource, content, opts): Promise<void>

• Parameters

  • resource: URI
  • content: Uint8Array
  • opts: FileWriteOptions

  Returns Promise<void>