Skip to main content

readSync

function readSync
Jump to headingreadSync(
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 Jump to heading

Jump to headingbuffer: ArrayBufferView
Jump to headingoffset: number
Jump to headinglength: number
optional
Jump to headingposition: ReadPosition | null = 'null'

Return Type Jump to heading

number
Jump to headingreadSync(
fd: number,
buffer: ArrayBufferView,
): 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.

Parameters Jump to heading

Jump to headingbuffer: ArrayBufferView

Return Type Jump to heading

number
Back to top