Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/npm/cli.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/minipass-collect/README.md')
-rw-r--r--node_modules/minipass-collect/README.md48
1 files changed, 0 insertions, 48 deletions
diff --git a/node_modules/minipass-collect/README.md b/node_modules/minipass-collect/README.md
deleted file mode 100644
index ae1c3daca..000000000
--- a/node_modules/minipass-collect/README.md
+++ /dev/null
@@ -1,48 +0,0 @@
-# minipass-collect
-
-A Minipass stream that collects all the data into a single chunk
-
-Note that this buffers ALL data written to it, so it's only good for
-situations where you are sure the entire stream fits in memory.
-
-Note: this is primarily useful for the `Collect.PassThrough` class, since
-Minipass streams already have a `.collect()` method which returns a promise
-that resolves to the array of chunks, and a `.concat()` method that returns
-the data concatenated into a single Buffer or String.
-
-## USAGE
-
-```js
-const Collect = require('minipass-collect')
-
-const collector = new Collect()
-collector.on('data', allTheData => {
- console.log('all the data!', allTheData)
-})
-
-someSourceOfData.pipe(collector)
-
-// note that you can also simply do:
-someSourceOfData.pipe(new Minipass()).concat().then(data => ...)
-// or even, if someSourceOfData is a Minipass:
-someSourceOfData.concat().then(data => ...)
-// but you might prefer to have it stream-shaped rather than
-// Promise-shaped in some scenarios.
-```
-
-If you want to collect the data, but _also_ act as a passthrough stream,
-then use `Collect.PassThrough` instead (for example to memoize streaming
-responses), and listen on the `collect` event.
-
-```js
-const Collect = require('minipass-collect')
-
-const collector = new Collect.PassThrough()
-collector.on('collect', allTheData => {
- console.log('all the data!', allTheData)
-})
-
-someSourceOfData.pipe(collector).pipe(someOtherStream)
-```
-
-All [minipass options](http://npm.im/minipass) are supported.