Interface FileHandle

path

readable

writable

close

• close(): Promise<void>

• Closes the file.

  Returns Promise<void>

datasync

• datasync(): Promise<void>

• See fdatasync(2)

  Returns Promise<void>

read

• read(buffer, offset?): Promise<number>

• Reads data into the given buffer at the given file offset. Returns the amount of read data or null for EOF.

  Parameters

  • buffer: Uint8Array

    Buffer to read data into.

  • Optional offset: number

    Offset in the file to read from.

  Returns Promise<number>

stat

• stat(): Promise<StatResult>

• Get the file status information. See stat(2)

  Returns Promise<StatResult>

sync

• sync(): Promise<void>

• See fsync(2)

  Returns Promise<void>

truncate

• truncate(offset?): Promise<void>

• Truncates the file to the given length.

  Parameters

  • Optional offset: number

    Length to truncate the file to.

  Returns Promise<void>

write

• write(buffer, offset?): Promise<number>

• Writes data from the given buffer at the given file offset. Returns the amount of data written.

  Parameters

  • buffer: Uint8Array

    Buffer to write.

  • Optional offset: number

    Offset in the file to write to.

  Returns Promise<number>