Skip to main content
Skip to main content

ReadableOptions

Properties

autoDestroyboolean
emitCloseboolean
highWaterMarknumber
objectModeboolean
signalAbortSignal
When provided the corresponding AbortController can be used to cancel an asynchronous action.

Methods

construct

Parameters

thisReadableRequired
callback(error?: null | Error) => voidRequired

Returns

voidvoid

destroy

Parameters

thisReadableRequired
errornull | ErrorRequired
callback(error: null | Error) => voidRequired

Returns

voidvoid

read

Parameters

thisReadableRequired
sizenumberRequired

Returns

voidvoid
Was this section helpful?