WritableOptions

internal.internal.WritableOptions

Properties

autoDestroyboolean

decodeStringsboolean

defaultEncodingBufferEncoding

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

thisWritableRequired

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

Returns

void

voidvoid

Inherited from

StreamOptions.construct

---

destroy

Optional destroy(this, error, callback): void

Parameters

thisWritableRequired

errornull | ErrorRequired

callback(error: null | Error) => voidRequired

Returns

void

voidvoid

Inherited from

StreamOptions.destroy

---

final

Optional final(this, callback): void

Parameters

thisWritableRequired

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

Returns

void

voidvoid

---

write

Optional write(this, chunk, encoding, callback): void

Parameters

thisWritableRequired

chunkanyRequired

encodingBufferEncodingRequired

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

Returns

void

voidvoid

---

writev

Optional writev(this, chunks, callback): void

Parameters

thisWritableRequired

chunks{ chunk: any ; encoding: BufferEncoding }[]Required

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

Returns

void

voidvoid