Skip to content

nfroidure/plexer

Repository files navigation

plexer

A stream duplexer embracing Streams 2.0 (for real).

GitHub license Build status Coverage Status NPM version Dependency Status devDependency Status Package Quality Code Climate

## Usage

plexer([options,] writable, readable)

options

options.reemitErrors

Type: Boolean Default value: true

Tells the duplexer to reemit given streams errors.

options.objectMode

Type: Boolean Default value: false

Use if given in streams are in object mode. In this case, the duplexer will also be in the object mode.

options.*

Plexer inherits of Stream.Duplex, the options are passed to the parent constructor so you can use it's options too.

writable

Type: Stream

Required. Any writable stream.

readable

Type: Stream

Required. Any readable stream.

plexer.obj([options], writable, readable)

A shortcut for plexer({objectMode: true}).

Stats

NPM NPM

Contributing

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

Authors

License

MIT

About

A streams2 duplexer.

Resources

License

Code of conduct

Stars

Watchers

Forks

Packages

No packages published