function readSync

Overload 1

#readSync(fd: number,
buffer: ArrayBufferView,
offset: number,
length: number,
position: ReadPosition | null,
): number

Returns the number of bytesRead.

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

Parameters #

#fd: number

#buffer: ArrayBufferView

#offset: number

#length: number

#position: ReadPosition | null = 'null'

optional

Return Type #

number

Overload 2

#readSync(fd: number,
buffer: ArrayBufferView,
opts?: ReadSyncOptions,
): 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.