get-stream alternatives and similar modules
Based on the "Streams" category.
Alternatively, view get-stream alternatives based on common mentions on social networks and blogs.
-
-
-
-
concat-stream
writable stream that concatenates strings or data and calls a callback with the result -
-
-
scramjet
Public tracker for Scramjet Cloud Platform, a platform that bring data from many environments together. -
-
duplexify
Turn a writable and readable stream into a streams2 duplex stream with support for async initialization and streams1/streams2 input -
into-stream
Convert a string/promise/array/iterable/asynciterable/buffer/typedarray/arraybuffer/object into a stream -
-
binary-split
a fast newline (or any delimiter) splitter stream - like require('split') but specific for binary data -
through2-concurrent
Simple Node.JS stream (streams2) Transform that runs the transform functions concurrently (with a set max concurrency) -
graphicsmagick-stream
DISCONTINUED. Fast conversion/scaling of images using a pool of long lived GraphicsMagick processes. -
-
-
InfluxDB – Built for High-Performance Time Series Workloads
* Code Quality Rankings and insights are calculated and provided by Lumnify.
They vary from L1 to L5 with "L5" being the highest.
Do you think we are missing an alternative of get-stream or a related project?
README
get-stream
Get a stream as a string, buffer, or array
Install
$ npm install get-stream
Usage
const fs = require('fs');
const getStream = require('get-stream');
(async () => {
const stream = fs.createReadStream('unicorn.txt');
console.log(await getStream(stream));
/*
,,))))))));,
__)))))))))))))),
\|/ -\(((((''''((((((((.
-*-==//////(('' . `)))))),
/|\ ))| o ;-. '((((( ,(,
( `| / ) ;))))' ,_))^;(~
| | | ,))((((_ _____------~~~-. %,;(;(>';'~
o_); ; )))(((` ~---~ `:: \ %%~~)(v;(`('~
; ''''```` `: `:::|\,__,%% );`'; ~
| _ ) / `:|`----' `-'
______/\/~ | / /
/~;;.____/;;' / ___--,-( `;;;/
/ // _;______;'------~~~~~ /;;/\ /
// | | / ; \;;,\
(<_ | ; /',/-----' _>
\_| ||_ //~;~~~~~~~~~
`\_| (,~~
\~\
~~
*/
})();
API
The methods returns a promise that resolves when the end event fires on the stream, indicating that there is no more data to be read. The stream is switched to flowing mode.
getStream(stream, options?)
Get the stream as a string.
options
Type: object
encoding
Type: string\
Default: 'utf8'
Encoding of the incoming stream.
maxBuffer
Type: number\
Default: Infinity
Maximum length of the returned string. If it exceeds this value before the stream ends, the promise will be rejected with a getStream.MaxBufferError error.
getStream.buffer(stream, options?)
Get the stream as a buffer.
It honors the maxBuffer option as above, but it refers to byte length rather than string length.
getStream.array(stream, options?)
Get the stream as an array of values.
It honors both the maxBuffer and encoding options. The behavior changes slightly based on the encoding chosen:
When
encodingis unset, it assumes an object mode stream and collects values emitted fromstreamunmodified. In this casemaxBufferrefers to the number of items in the array (not the sum of their sizes).When
encodingis set tobuffer, it collects an array of buffers.maxBufferrefers to the summed byte lengths of every buffer in the array.When
encodingis set to anything else, it collects an array of strings.maxBufferrefers to the summed character lengths of every string in the array.
Errors
If the input stream emits an error event, the promise will be rejected with the error. The buffered data will be attached to the bufferedData property of the error.
(async () => {
try {
await getStream(streamThatErrorsAtTheEnd('unicorn'));
} catch (error) {
console.log(error.bufferedData);
//=> 'unicorn'
}
})()
FAQ
How is this different from concat-stream?
This module accepts a stream instead of being one and returns a promise instead of using a callback. The API is simpler and it only supports returning a string, buffer, or array. It doesn't have a fragile type inference. You explicitly choose what you want. And it doesn't depend on the huge readable-stream package.
Related
- get-stdin - Get stdin as a string or buffer
Get professional support for this package with a Tidelift subscription Tidelift helps make open source sustainable for maintainers while giving companiesassurances about security, maintenance, and licensing for their dependencies.