aboutsummaryrefslogtreecommitdiff
path: root/node_modules/into-stream/readme.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/into-stream/readme.md')
-rw-r--r--node_modules/into-stream/readme.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/node_modules/into-stream/readme.md b/node_modules/into-stream/readme.md
new file mode 100644
index 0000000..6c4ed0b
--- /dev/null
+++ b/node_modules/into-stream/readme.md
@@ -0,0 +1,42 @@
+# into-stream [![Build Status](https://travis-ci.org/sindresorhus/into-stream.svg?branch=master)](https://travis-ci.org/sindresorhus/into-stream)
+
+> Convert a buffer/string/array/object/iterable/promise into a stream
+
+Correctly chunks up the input and handles backpressure.
+
+
+## Install
+
+```
+$ npm install --save into-stream
+```
+
+
+## Usage
+
+```js
+const intoStream = require('into-stream');
+
+intoStream('unicorn').pipe(process.stdout);
+//=> 'unicorn'
+```
+
+
+## API
+
+### intoStream(input)
+
+Type: `Buffer` `string` `Iterable<Buffer|string>` `Promise`<br>
+Returns: [Readable stream](https://nodejs.org/api/stream.html#stream_class_stream_readable)
+
+Adheres to the requested chunk size, except for `array` where each element will be a chunk.
+
+### intoStream.obj(input)
+
+Type: `Object`, `Iterable<Object>` `Promise`<br>
+Returns: [Readable object stream](https://nodejs.org/api/stream.html#stream_object_mode)
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)