Class NodeFileSource

ReadonlymimeType

Readonlyname

Readonlysize

close

• close(): Promise<void>

  Close the open file handle, if any.

  Returns Promise<void>

slice

• slice(offset: number, length: number): Promise<ArrayBuffer>

  Read up to length bytes from offset, opening the file for reading on first use.

  Parameters

  • offset: number

    Byte offset at which to start reading.

  • length: number

    Maximum number of bytes to read; the result is truncated to the bytes actually read at end-of-file.

  Returns Promise<ArrayBuffer>

  The bytes read.

Staticcreate

• create(
      path: string,
      opts?: { mimeType?: string; name?: string },
  ): Promise<NodeFileSource>

  Create a source for a file on disk, reading its size via stat.

  Parameters

  • path: string

    Path to the file to send.

  • opts: { mimeType?: string; name?: string } = {}

    Optional overrides: name (advertised file name, defaults to the basename) and mimeType (defaults to application/octet-stream).

  Returns Promise<NodeFileSource>

  A ready-to-use NodeFileSource.