promise-duplex
This module allows to convert
Duplex
stream
into its promisified version, which returns
Promise
object fulfilled when stream's events occurred.
The module combines
promise-readable
and
promise-writable
in one.
Requirements
This module requires Node >= 6.
Installation
npm install promise-duplex
Usage
const PromiseDuplex =
Typescript:
// or
constructor
const promiseDuplex = stream
PromiseDuplex
object requires Duplex
object to work.
Example:
const net = const PromiseDuplex = const stream = const promiseDuplex = stream
Typescript:
stream
const stream = promiseDuplexstream
Original stream object.
Example:
console
read
const chunk = await promiseDuplex
Check
PromiseReadable.read
for details.
readAll
const content = await promiseDuplex
Check
PromiseReadable.readAll
for details.
iterate
for await const chunk of promiseDuplex
Check
PromiseReadable.iterate
for details.
Symbol.asyncIterator
for await const chunk of promiseDuplex
Check
PromiseReadable[Symbol.asyncIterator]
for details.
setEncoding
promiseDuplex = await promiseDuplex
Check
PromiseReadable.setEncoding
for details.
write
await promiseDuplex
Check
PromiseWritable.write
for details.
writeAll
await promiseDuplex
Check
PromiseWritable.writeAll
for details.
end
await promiseDuplex
Check
PromiseWritable.once
for details.
once
const result = await promiseDuplex
Check
PromiseReadable.once
and
PromiseWritable.once
for details.
destroy
promiseDuplex
This method calls destroy method on stream and cleans up all own handlers.
See also
PromiseReadable
,
PromiseWritable
,
PromiseSocket
,
PromisePiping
.
License
Copyright (c) 2017-2019 Piotr Roszatycki piotr.roszatycki@gmail.com