Skip to main content
promises.FileHandle.read - node__fs.d.ts - Node documentation
method promises.FileHandle.read

Usage in Deno

```typescript import { type promises } from "node:node__fs.d.ts"; ```
FileHandle.read<T extends ArrayBufferView>(
buffer: T,
offset?: number | null,
length?: number | null,
position?: number | null,
): Promise<FileReadResult<T>>
Reads data from the file and stores that in the given buffer. If the file is not modified concurrently, the end-of-file is reached when the number of bytes read is zero.

Type Parameters

T extends ArrayBufferView

Parameters

buffer: T
A buffer that will be filled with the file data read.
optional
offset: number | null
The location in the buffer at which to start filling.
optional
length: number | null
The number of bytes to read.
optional
position: number | null
The location where to begin reading data from the file. If `null`, data will be read from the current file position, and the position will be updated. If `position` is an integer, the current file position will remain unchanged.

Return Type

Promise<FileReadResult<T>>
Fulfills upon success with an object with two properties:
FileHandle.read<T extends ArrayBufferView = Buffer>(options?: FileReadOptions<T>): Promise<FileReadResult<T>>

Type Parameters

T extends ArrayBufferView = Buffer

Parameters

optional
options: FileReadOptions<T>

Return Type

Promise<FileReadResult<T>>