Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

plexer

nfroidure139.1kMIT3.0.0TypeScript support: included

Create a duplex stream from a readable and a writable stream.

duplexer, streaming, stream2, stream, readable, writable, async, pipe

readme

plexer

Create a duplex stream from a readable and a writable stream.

GitHub license

Stats

NPM NPM

Contributing

Feel free to pull your code if you agree with publishing it under the MIT license.

API

Classes

Duplexer

Create a duplex stream from a readable and a writable stream.cd

Functions

createObjectsDuplexer(optionsOrWritableStream, writableStreamOrReadableStream, maybeReadableStream)

A shortcut for new Duplexer({objectMode: true}, writable, readable).

createDuplexer(optionsOrWritableStream, writableStreamOrReadableStream, maybeReadableStream)

A functional version of Duplexer.

Duplexer

Create a duplex stream from a readable and a writable stream.cd

Kind: global class

new Duplexer(optionsOrWritableStream, writableStreamOrReadableStream, a)

Creates the Duplexer instance

Returns: Duplexer

Param Type Description
optionsOrWritableStream | options or the writable stream
writableStreamOrReadableStream | writable or readable stream
a maybeReadableStream readable stream

createObjectsDuplexer(optionsOrWritableStream, writableStreamOrReadableStream, maybeReadableStream) ⇒

A shortcut for new Duplexer({objectMode: true}, writable, readable).

Kind: global function
Returns: Duplexer

Param
optionsOrWritableStream
writableStreamOrReadableStream
maybeReadableStream

createDuplexer(optionsOrWritableStream, writableStreamOrReadableStream, maybeReadableStream) ⇒

A functional version of Duplexer.

Kind: global function
Returns: Duplexer

Param
optionsOrWritableStream
writableStreamOrReadableStream
maybeReadableStream

Authors

License

MIT

changelog

3.0.0 (2024-07-18)

Code Refactoring

  • core: switch to TypeScript (dfb5ea2)

BREAKING CHANGES

  • core: Requires ESM, API breaking changes, requires Node20+.

2.0.0 (2019-08-27)

1.0.3 (2019-08-27)

1.0.2 (2017-12-03)

build

  • metapak-nfroidure: Add metapak-nfroidure (b6a45e1)

BREAKING CHANGES

  • metapak-nfroidure: Removing support for versions minors to the last LTS

v1.0.1 (2015/09/07 08:07 +00:00)

  • 50bb4a3 1.0.1 (@nfroidure)
  • 11da719 Updating deps + package cleanup (@nfroidure)

v1.0.0 (2015/08/02 13:17 +00:00)

  • b3ffeb1 1.0.0 (@nfroidure)
  • 4fdd0c8 Adding utility scripts (@nfroidure)
  • fd10914 Deps updates (@nfroidure)
  • 3e275bf Adding linting and suppress most errors (@nfroidure)
  • e17116e Converting test to use streamtest (@nfroidure)
  • 977c1ef Adding a .obj shortcut fix #2 (@nfroidure)
  • ee32748 Version update (@nfroidure)
  • f89b62b Readme update (@nfroidure)
  • 9268bab Version 0.0.2 fix (@nfroidure)
  • 7912e54 New version 0.0.2 (@nfroidure)
  • 45ced23 Added badges (@nfroidure)
  • b325bd9 Dependencies update (@nfroidure)
  • b9623b5 Switching to readable-stream (@nfroidure)
  • 1a489ea Typo fixes + more doc (@nfroidure)
  • bb1156b First stable version (0.0.1) (@nfroidure)
  • 441d329 Updated coveralls (@nfroidure)
  • 8fb3d1c Added support for objectMode (@nfroidure)
  • 65c7609 First commit (@nfroidure)