[//]: # ( )
[//]: # (This file is automatically generated by a `metapak`)
[//]: # (module. Do not change it  except between the)
[//]: # (`content:start/end` flags, your changes would)
[//]: # (be overridden.)
[//]: # ( )
# plexer
> Create a duplex stream from a readable and a writable stream.

[![GitHub license](https://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/nfroidure/plexer/blob/main/LICENSE)


[//]: # (::contents:start)

## Stats

[![NPM](https://nodei.co/npm/plexer.png?downloads=true&stars=true)](https://nodei.co/npm/plexer/)
[![NPM](https://nodei.co/npm-dl/plexer.png)](https://nodei.co/npm/plexer/)

## Contributing

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

[//]: # (::contents:end)

# API
## Classes

<dl>
<dt><a href="#Duplexer">Duplexer</a></dt>
<dd><p>Create a duplex stream from a readable and a writable stream.cd</p>
</dd>
</dl>

## Functions

<dl>
<dt><a href="#createObjectsDuplexer">createObjectsDuplexer(optionsOrWritableStream, writableStreamOrReadableStream, maybeReadableStream)</a> ⇒</dt>
<dd><p>A shortcut for <code>new Duplexer({objectMode: true}, writable, readable)</code>.</p>
</dd>
<dt><a href="#createDuplexer">createDuplexer(optionsOrWritableStream, writableStreamOrReadableStream, maybeReadableStream)</a> ⇒</dt>
<dd><p>A functional version of Duplexer.</p>
</dd>
</dl>

<a name="Duplexer"></a>

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

**Kind**: global class  
<a name="new_Duplexer_new"></a>

### 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 | <code>maybeReadableStream</code> | readable stream |

<a name="createObjectsDuplexer"></a>

## createObjectsDuplexer(optionsOrWritableStream, writableStreamOrReadableStream, maybeReadableStream) ⇒
A shortcut for `new Duplexer({objectMode: true}, writable, readable)`.

**Kind**: global function  
**Returns**: Duplexer  

| Param |
| --- |
| optionsOrWritableStream | 
| writableStreamOrReadableStream | 
| maybeReadableStream | 

<a name="createDuplexer"></a>

## createDuplexer(optionsOrWritableStream, writableStreamOrReadableStream, maybeReadableStream) ⇒
A functional version of Duplexer.

**Kind**: global function  
**Returns**: Duplexer  

| Param |
| --- |
| optionsOrWritableStream | 
| writableStreamOrReadableStream | 
| maybeReadableStream | 


# Authors
- [Nicolas Froidure](http://insertafter.com/en/index.html)

# License
[MIT](https://github.com/nfroidure/plexer/blob/main/LICENSE)