aboutsummaryrefslogtreecommitdiff
path: root/node_modules/to-readable-stream/readme.md
diff options
context:
space:
mode:
authorMinteck <contact@minteck.org>2022-04-09 16:39:03 +0200
committerMinteck <contact@minteck.org>2022-04-09 16:40:02 +0200
commit0f8967b9113d698cdeb2d05ca85d2d9a80461c24 (patch)
tree00664ddd9c55a2c33631fd1bd33e556cea9c67e5 /node_modules/to-readable-stream/readme.md
parentdac03ac82bc0f8044a4b339c27b5390e4dcecf2f (diff)
downloadvoicer-trunk.tar.gz
voicer-trunk.tar.bz2
voicer-trunk.zip
CommitHEADtrunk
Diffstat (limited to 'node_modules/to-readable-stream/readme.md')
-rw-r--r--node_modules/to-readable-stream/readme.md42
1 files changed, 42 insertions, 0 deletions
diff --git a/node_modules/to-readable-stream/readme.md b/node_modules/to-readable-stream/readme.md
new file mode 100644
index 0000000..fc207c5
--- /dev/null
+++ b/node_modules/to-readable-stream/readme.md
@@ -0,0 +1,42 @@
+# to-readable-stream [![Build Status](https://travis-ci.org/sindresorhus/to-readable-stream.svg?branch=master)](https://travis-ci.org/sindresorhus/to-readable-stream)
+
+> Convert a string/Buffer/Uint8Array to a [readable stream](https://nodejs.org/api/stream.html#stream_readable_streams)
+
+
+## Install
+
+```
+$ npm install to-readable-stream
+```
+
+
+## Usage
+
+```js
+const toReadableStream = require('to-readable-stream');
+
+toReadableStream('🦄🌈').pipe(process.stdout);
+```
+
+
+## API
+
+### toReadableStream(input)
+
+Returns a [`stream.Readable`](https://nodejs.org/api/stream.html#stream_readable_streams).
+
+#### input
+
+Type: `string` `Buffer` `Uint8Array`
+
+Value to convert to a stream.
+
+
+## Related
+
+- [into-stream](https://github.com/sindresorhus/into-stream) - More advanced version of this module
+
+
+## License
+
+MIT © [Sindre Sorhus](https://sindresorhus.com)