promise-writable
This module allows to convert
Writable
stream into its promisified version, which returns
Promise
object fulfilled when open
,
close
,
pipe
,
unpipe
,
finish
or
error
events
occurred.
Requirements
This module requires Node >= 6.
Installation
npm install promise-writable
Additionally for Typescript:
npm install -D @types/node
Usage
const PromiseWritable =
Typescript:
// or
constructor
const promiseWritable = stream
PromiseWritable
object requires Writable
object to work.
Example:
const PromiseWritable = const fs = const stream = fsconst promiseWritable = stream
Typescript:
stream
const stream = promiseWritablestream
Original stream object.
Example:
console
write
const written = await promiseWritable
This method returns Promise
which is fulfilled when stream accepted a
chunk (write
method returned that stream is still writable or drain
event
occured) or stream is ended (finish
event).
Promise resolves to number of written bytes.
Example:
const written = await promiseWritable
writeAll
const total = await promiseWritable
This method returns Promise
which is fulfilled when stream accepted a
content. This method writes the content chunk by chunk. The default chunk size
is 64 KiB.
Promise resolves to number of written bytes.
Example:
const total = await promiseWritable
once
await promiseWritable
This method returns Promise
which is fulfilled when stream emits event
. The
result of this event is returned.
Promise resolves to undefined
value if stream is already closed or destoyed.
Example:
const fd = await promiseWritableprocess await promiseWritable const promise = promiseWritableprocessstdinconst src = await promise const promise = promiseWritableprocessstdinconst src = await promise
end
await promiseWritable
This method ends the stream and returns Promise
which is fulfilled when stream
is finished. No value is returned.
destroy
promiseWritable
This method calls destroy method on stream and cleans up all own handlers.
See also
PromiseReadable
,
PromiseDuplex
,
PromiseSocket
,
PromisePiping
.
License
Copyright (c) 2017-2019 Piotr Roszatycki mailto:piotr.roszatycki@gmail.com