StreamOptions

internal.internal.StreamOptions

Type parameters

TStreamRequired

Properties

autoDestroyboolean

emitCloseboolean

highWaterMarknumber

objectModeboolean

signalAbortSignal

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

Methods

construct

Optional construct(this, callback): void

Parameters

thisTRequired

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

Returns

void

voidvoid

---

destroy

Optional destroy(this, error, callback): void

Parameters

thisTRequired

errornull | ErrorRequired

callback(error: null | Error) => voidRequired

Returns

void

voidvoid