Class Client

constructor

• new Client(prefix: Name, opts?: ClientOptions): Client

• Parameters

  • prefix: Name
  • opts: ClientOptions = {}

  Returns Client

Readonlyprefix

readdir

• readdir(m: FileMetadata): AsyncIterable<DirEntry>

• List directory.

  Parameters

  • m: FileMetadata

    Metadata of a directory.

  Returns AsyncIterable<DirEntry>

readFile

• readFile(m: FileMetadata): fetch.Result

• Retrieve entire contents of a file.

  Parameters

  • m: FileMetadata

    Metadata of a file.

  Returns fetch.Result

readFileInto

• readFileInto(
      m: FileMetadata,
      buffer: Uint8Array,
      offset: number,
      length: number,
      position: number,
  ): Promise<void>

• Retrieve part of a file into a buffer.

  Parameters

  • m: FileMetadata

    Metadata of a file.
  • buffer: Uint8Array

    The buffer that file contents will be written into.
  • offset: number

    The offset within the buffer where writing will start.
  • length: number

    The number of bytes to retrieve.
  • position: number

    Where to begin reading from the file.

  Returns Promise<void>

stat

• stat(relPath: string): Promise<FileMetadata>

• Retrieve metadata of given relative path.

  Parameters

  • relPath: string

    File or directory path underneath the mount point.

  Returns Promise<FileMetadata>
• stat(parentRelPath: string, de: DirEntry): Promise<FileMetadata>

• Retrieve metadata of given relative path and directory entry.

  Parameters

  • parentRelPath: string

    Parent directory path underneath the mount point.
  • de: DirEntry

    Child directory entry.

  Returns Promise<FileMetadata>