Skip to main content

Interface: NodeWritableLike

Minimal writable-stream shape accepted by NodeStreamSink.

Methods​

end()​

end(callback?): unknown;

Ends the writable stream.

Parameters​

ParameterType
callback?(error?) => void

Returns​

unknown

off()?​

Call Signature​

optional off(event, listener): unknown;

Removes a previously registered drain listener.

Parameters​
ParameterType
event"drain"
listener() => void
Returns​

unknown

Call Signature​

optional off(event, listener): unknown;

Removes a previously registered error listener.

Parameters​
ParameterType
event"error"
listener(error) => void
Returns​

unknown

once()​

Call Signature​

once(event, listener): unknown;

Registers a one-time listener for the drain event.

Parameters​
ParameterType
event"drain"
listener() => void
Returns​

unknown

Call Signature​

once(event, listener): unknown;

Registers a one-time listener for the error event.

Parameters​
ParameterType
event"error"
listener(error) => void
Returns​

unknown

write()​

write(chunk, callback?): boolean;

Writes a byte chunk and reports whether the stream is ready for more data.

Parameters​

ParameterType
chunkUint8Array
callback?(error?) => void

Returns​

boolean