promise-piping
This module allows to convert stacked streams into one
Promise
object.
The piping object can be open-ended
PromiseReadable
object or
PromiseWritable
object or
close-ended.
The piping object can be build from streams: standard objects or promisified versions or another piping objects.
Requirements
This module requires Node >= 4. For Node < 6 --harmony
flag is required.
Installation
npm install promise-piping
Usage
const PromiseReadablePiping PromiseWritablePiping PromisePiping } =
or:
const PromisePiping =
Typescript:
or:
constructor
const readablePiping = readable duplex...const writablePiping = duplex... writableconst piping = readable duplex... writable
Example:
const fs = const zlib = const filein = fsconst fileout = fsconst gzip = zlibconst gunzip = zlib const readablePiping = filein gzip gunzipconst writablePiping = gzip fileoutconst piping = filein gzip fileout
once
const result = await piping
This method returns Promise
which is fulfilled when last stream (first
stream for end
event) emits event. The result of this event is returned
or undefined
value if stream is already ended.
The promise will reject on error. Errors in piping are propagated from intermediate streams to the first stream and the last stream. It means that operation on piping will be rejected if an error occurs in any of its streams.
Example:
await piping
destroy
piping
This method calls destroy method on stream and cleans up all own handlers.
See also
PromiseReadable
,
PromiseWritable
,
PromiseDuplex
,
PromiseSocket
.
License
Copyright (c) 2017-2018 Piotr Roszatycki mailto:piotr.roszatycki@gmail.com