function

fs.readSync

function readSync(
fd: number,
buffer: ArrayBufferView,
offset: number,
length: number,
position?: null | ReadPosition
): number;

Returns the number of bytesRead.

For detailed information, see the documentation of the asynchronous version of this API: read.

function readSync(
fd: number,
buffer: ArrayBufferView,
opts?: ReadOptions
): number;

Similar to the above fs.readSync function, this version takes an optional options object. If no options object is specified, it will default with the above values.

Referenced types

type ReadPosition = number | bigint

interface ReadOptions