ReadableOptions

internal.internal.ReadableOptions

Properties

autoDestroyboolean

emitCloseboolean

encodingBufferEncoding

highWaterMarknumber

objectModeboolean

signalAbortSignal

When provided the corresponding AbortController can be used to cancel an asynchronous action.

Methods

construct

Optional construct(this, callback): void

Parameters

thisReadableRequired

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

Returns

void

voidvoid

Inherited from

StreamOptions.construct

---

destroy

Optional destroy(this, error, callback): void

Parameters

thisReadableRequired

errornull | ErrorRequired

callback(error: null | Error) => voidRequired

Returns

void

voidvoid

Inherited from

StreamOptions.destroy

---

read

Optional read(this, size): void

Parameters

thisReadableRequired

sizenumberRequired

Returns

void

voidvoid