Class OPFSFileSystemProvider

constructor

• new OPFSFileSystemProvider(): OPFSFileSystemProvider

  Returns OPFSFileSystemProvider

capabilities

onDidChangeCapabilities

ReadonlyonDidChangeFile

ReadonlyonFileWatchError

clear

• clear(): Promise<void>

  Clears the file system

  Returns Promise<void>

close

• close(fd: number): Promise<void>

  Closes a file descriptor

  Parameters

  • fd: number

  Returns Promise<void>

copy

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

  Copies a resource from one location to another

  Parameters

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

  Returns Promise<void>

createIndex

• createIndex(entries: Map<URI, Uint8Array>): Promise<void>

  Creates an index from the map of entries

  Parameters

  • entries: Map<URI, Uint8Array>

  Returns Promise<void>

delete

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

  Deletes a resource

  Parameters

  • resource: URI
  • opts: FileDeleteOptions

  Returns Promise<void>

dispose

• dispose(): void

  Disposes the file system provider

  Returns void

exists

• exists(resource: URI): Promise<boolean>

  Checks if a resource exists

  Parameters

  • resource: URI

  Returns Promise<boolean>

index

• index(): Promise<Map<URI, Stat>>

  Retrieves the current file system index

  Returns Promise<Map<URI, Stat>>

mkdir

• mkdir(resource: URI): Promise<void>

  Creates a directory

  Parameters

  • resource: URI

  Returns Promise<void>

open

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

  Opens a file and returns a file descriptor

  Parameters

  • resource: URI
  • opts: FileOpenOptions

  Returns Promise<number>

read

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

  Reads data from a file descriptor

  Parameters

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

  Returns Promise<number>

readdir

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

  Reads directory contents

  Parameters

  • resource: URI

  Returns Promise<[string, FileType][]>

readFile

• readFile(resource: URI): Promise<Uint8Array>

  Reads file content as binary data

  Parameters

  • resource: URI

  Returns Promise<Uint8Array>

readFileStream

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

  Reads file content as a stream

  Parameters

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

  Returns ReadableStreamEvents<Uint8Array>

rename

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

  Renames a resource from one location to another

  Parameters

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

  Returns Promise<void>

stat

• stat(resource: URI): Promise<Stat>

  Gets file system statistics for a resource

  Parameters

  • resource: URI

  Returns Promise<Stat>

updateFile

• updateFile(
      resource: URI,
      changes: TextDocumentContentChangeEvent[],
      opts: FileUpdateOptions,
  ): Promise<FileUpdateResult>

  Updates a text file with content changes

  Parameters

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

  Returns Promise<FileUpdateResult>

watch

• watch(resource: URI, opts: WatchOptions): Disposable

  Watches a resource for file system changes

  Parameters

  • resource: URI
  • opts: WatchOptions

  Returns Disposable

write

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

  Writes data to a file descriptor

  Parameters

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

  Returns Promise<number>

writeFile

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

  Writes binary content to a file

  Parameters

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

  Returns Promise<void>