undefined \| Promise
- [.fromString(string, [encoding])](#Streams+fromString) ⇒ Readable
- [.newReadable([params])](#Streams+newReadable) ⇒ Readable
- [.newWritable([params])](#Streams+newWritable) ⇒ Writable
- [.pipeline([callback])](#Streams+pipeline) ⇒ undefined \| Promise
- [.stringify(readable, [callback])](#Streams+stringify) ⇒ undefined \| Promise
### streams.Duplex
**Kind**: instance class of [Streams](#Streams)
**Access**: public
#### new Streams#Duplex()
A stream that is both Readable and Writable (for example, a TCP socket connection or net.Socket).
See Node.js's documentation about [Duplex](https://nodejs.org/api/stream.html#stream_implementing_a_duplex_stream).
### streams.PassThrough
**Kind**: instance class of [Streams](#Streams)
**Access**: public
#### new Streams#PassThrough()
A trivial implementation of a Transform stream that simply passes the input bytes across to the output.
See Node.js's documentation about [PassThrough](https://nodejs.org/api/stream.html#stream_class_stream_passthrough).
### streams.Readable
**Kind**: instance class of [Streams](#Streams)
**Access**: public
#### new Streams#Readable()
A stream from which data can be read, an abstraction of a source (for example, [fs.createReadStream()](https://nodejs.org/api/fs.html#fs_fs_createreadstream_path_options)).
See Node.js's documentation about [Readable](https://nodejs.org/api/stream.html#stream_readable_streams).
### streams.Stream
**Kind**: instance class of [Streams](#Streams)
**Access**: public
#### new Streams#Stream()
An abstraction of sources (a place where data can be read from) and destinations (a place where data can be written to).
See Node.js's documentation about [Stream](https://nodejs.org/api/stream.html).
### streams.Transform
**Kind**: instance class of [Streams](#Streams)
**Access**: public
#### new Streams#Transform()
[Duplex](Duplex) streams where the output is in some way related to the input (for example, [zlib.createDeflate()](https://nodejs.org/api/zlib.html#zlib_zlib_createdeflate_options)).
See Node.js's documentation about [Transform](https://nodejs.org/api/stream.html#stream_class_stream_transform).
### streams.Writable
**Kind**: instance class of [Streams](#Streams)
**Access**: public
#### new Streams#Writable()
A stream to which data can be written, an abstraction of a destination (for example, [fs.createWriteStream()](https://nodejs.org/api/fs.html#fs_fs_createwritestream_path_options)).
See Node.js's documentation about [Writable](https://nodejs.org/api/stream.html#stream_writable_streams).
### streams.finished(stream, [callback]) ⇒ undefined \| Promise
Sends a notification when a stream is no longer readable, writable, or has experienced an error or a premature close event.
See Node.js's documentation about [finished](https://nodejs.org/api/stream.html#stream_stream_finished_stream_callback).
**Kind**: instance method of [Streams](#Streams)
**Returns**: undefined \| Promise - undefined if a callback is specified or a Promise that resolves once the stream has finished
**Throws**:
- Error If the Node.js version does not implement stream.finished
**Access**: public
| Param | Type | Description |
| ---------- | --------------------- | --------------------------------------------------------- |
| stream | Stream | A readable and/or writable stream |
| [callback] | function | A callback function that takes an optional error argument |
### streams.fromString(string, [encoding]) ⇒ Readable
Converts a string into a stream.
A [Stack Overflow answer](http://stackoverflow.com/a/22085851) inspired this implementation.
**Kind**: instance method of [Streams](#Streams)
**Returns**: Readable - A stream of the specified string
**Throws**:
- TypeError If string is not a string
**Access**: public
| Param | Type | Description |
| ---------- | ------------------- | -------------------------------------------------------------------------------------- |
| string | string | The string to convert into a stream |
| [encoding] | string | Encoding of the string that must be a valid Buffer encoding, such as 'utf8' or 'ascii' |
### streams.newReadable([params]) ⇒ Readable
Creates a new Readable stream.
See Node.js's documentation about [Readable](https://nodejs.org/api/stream.html#stream_new_stream_readable_options).
**Kind**: instance method of [Streams](#Streams)
**Returns**: Readable - A new Readable instance
**Access**: public
| Param | Type | Default | Description |
| ---------------------- | --------------------- | ------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------- |
| [params] | Object | | |
| [params.highWaterMark] | number | 16384 (16kb) or 16 for objectMode streams | The maximum number of bytes to store in the internal buffer before ceasing to read from the underlying resource |
| [params.encoding] | string | null | If specified, then buffers will be decoded to strings using the specified encoding |
| [params.objectMode] | boolean | false | Whether this stream should behave as a stream of objects meaning that stream.read(n) returns a single value instead of a Buffer of size n |
| [params.read] | function | | Implementation for the stream.\_read() method |
| [params.destroy] | function | | Implementation for the stream.\_destroy() method |
### streams.newWritable([params]) ⇒ Writable
Creates a new Writable stream.
See Node.js's documentation about [Writable](https://nodejs.org/api/stream.html#stream_constructor_new_stream_writable_options).
**Kind**: instance method of [Streams](#Streams)
**Returns**: Writable - A new Writable instance
**Access**: public
| Param | Type | Default | Description |
| ---------------------- | --------------------- | ------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [params] | Object | | |
| [params.highWaterMark] | number | 16384 (16kb) or 16 for objectMode streams | Buffer level when stream.write() starts returning false |
| [params.decodeStrings] | boolean | true | Whether or not to decode strings into Buffers before passing them to stream.\_write() |
| [params.objectMode] | boolean | false | Whether or not the stream.write(anyObj) is a valid operation. When set, it becomes possible to write JavaScript values other than string, Buffer or Uint8Array if supported by the stream implementation. |
| [params.emitClose] | boolean | true | Whether or not the stream should emit 'close' after it has been destroyed |
| [params.write] | function | | Implementation for the stream.\_write() method |
| [params.writev] | function | | Implementation for the stream.\_writev() method |
| [params.destroy] | function | | Implementation for the stream.\_destroy() method |
| [params.final] | function | | Implementation for the stream.\_final() method |
### streams.pipeline([callback]) ⇒ undefined \| Promise
Pipes between streams forwarding errors and properly cleaning up and notifies when the pipeline is complete via a callback or a Promise.
See Node.js's documentation about [pipeline](https://nodejs.org/api/stream.html#stream_stream_pipeline_streams_callback).
**Kind**: instance method of [Streams](#Streams)
**Returns**: undefined \| Promise - undefined if a callback is specified or a Promise that resolves once the pipeline is complete
**Throws**:
- Error If the Node.js version does not implement stream.pipeline
**Access**: public
| Param | Type | Description |
| ---------- | --------------------- | --------------------------------------------------------- |
| ...streams | Stream | Two or more streams to pipe between |
| [callback] | function | A callback function that takes an optional error argument |
### streams.stringify(readable, [callback]) ⇒ undefined \| Promise
Converts a stream into a string.
A [Stack Overflow answer](http://stackoverflow.com/a/26076032) inspired this implementation.
**Kind**: instance method of [Streams](#Streams)
**Returns**: undefined \| Promise - undefined if a callback is specified or a Promise that resolves with the resulting string
**Access**: public
| Param | Type | Description |
| ---------- | --------------------- | ------------------------------------------------------------------- |
| readable | Readable | The stream to convert into a string |
| [callback] | function | A callback function that takes two arguments, a string and an error |
---
_Source: https://npm.io/package/@util.js/streams · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._