Skip to content package
get-stream v7.0.0 Get a stream as a string or buffer
node >=16 0 deps esm types open source
overview readme
license MIT
deps 0
unpacked 9.1 kB
files 5
node >=16 $ npm install get-stream@7.0.0n npmREADME GitHub-flavored package documentation.
downloads Across all versions.
Download trend unavailable.
compatibility Runtime metadata.
keywords Tagged topics.
get stream promise concat string text buffer read data consume readable readablestream
versions Latest published Mar 16, 2024
maintainers Registry package owners.
install size Estimated unpacked size across 3 packages.
55.8 kB
Includes dependencies.
dependencies 2 direct · 1 outdated
npm install get-stream copy
Usage
Node.js streams import fs from 'node:fs' ;
import getStream from 'get-stream' ;
const stream = fs. createReadStream ( 'unicorn.txt' );
console. log ( await getStream (stream));
/*
,,))))))));,
__)))))))))))))),
\|/ -\(((((''''((((((((.
-*-==//////(('' . `)))))),
/|\ ))| o ;-. '((((( ,(,
( `| / ) ;))))' ,_))^;(~
| | | ,))((((_ _____------~~~-. %,;(;(>';'~
o_); ; )))(((` ~---~ `:: \ %%~~)(v;(`('~
; ''''```` `: `:::|\,__,%% );`'; ~
| _ ) / `:|`----' `-'
______/\/~ | / /
/~;;.____/;;' / ___--,-( `;;;/
/ // _;______;'------~~~~~ /;;/\ /
// | | / ; \;;,\
(<_ | ; /',/-----' _>
\_| ||_ //~;~~~~~~~~~
`\_| (,~~
\~\
~~
*/ copy
Web streams import getStream from 'get-stream' ;
const {body: readableStream} = await fetch ( 'https://example.com' );
console. log ( await getStream (readableStream)); copy This works in any browser, even the ones not supporting ReadableStream.values() yet.
Async iterables import {opendir} from 'node:fs/promises' ;
import {getStreamAsArray} from 'get-stream' ;
const asyncIterable = await opendir (directory);
console. log ( await getStreamAsArray (asyncIterable)); copy
API The following methods read the stream's contents and return it as a promise.
getStream(stream, options?) Get the given stream as a string.
getStreamAsBuffer(stream, options?) Get the given stream as a Node.js Buffer .
import {getStreamAsBuffer} from 'get-stream' ;
const stream = fs. createReadStream ( 'unicorn.png' );
console. log ( await getStreamAsBuffer (stream)); copy
getStreamAsArrayBuffer(stream, options?) import {getStreamAsArrayBuffer} from 'get-stream' ;
const {body: readableStream} = await fetch ( 'https://example.com' );
console. log ( await getStreamAsArrayBuffer (readableStream)); copy
getStreamAsArray(stream, options?) import {getStreamAsArray} from 'get-stream' ;
const {body: readableStream} = await fetch ( 'https://example.com' );
console. log ( await getStreamAsArray (readableStream)); copy
options
maxBuffer Type: number
Default: Infinity
Maximum length of the stream. If exceeded, the promise will be rejected with a MaxBufferError.
Errors If the stream errors, the returned promise will be rejected with the error. Any contents already read from the stream will be set to error.bufferedData, which is a string, a Buffer, an ArrayBuffer or an array depending on the method used .
import getStream from 'get-stream' ;
try {
await getStream ( streamThatErrorsAtTheEnd ( 'unicorn' ));
} catch (error) {
console. log (error.bufferedData);
//=> 'unicorn'
} copy
Browser support For this module to work in browsers, a bundler must be used that either:
Supports the exports.browser field in package.json
Strips or ignores node:* imports
Most bundlers (such as Webpack ) support either of these.
Tips
Alternatives If you do not need the maxBuffer option, error.bufferedData , nor browser support, you can use the following methods instead of this package.
import fs from 'node:fs' ;
import {text} from 'node:stream/consumers' ;
const stream = fs. createReadStream ( 'unicorn.txt' , {encoding: 'utf8' });
console. log ( await text (stream)) copy import {buffer} from 'node:stream/consumers' ;
console. log ( await buffer (stream)) copy import {arrayBuffer} from 'node:stream/consumers' ;
console. log ( await arrayBuffer (stream)) copy console. log ( await stream. toArray ()) copy console. log ( await Array. fromAsync (stream)) copy
Non-UTF-8 encoding When all of the following conditions apply:
import getStream from 'get-stream' ;
const textDecoderStream = new TextDecoderStream ( 'utf-16le' );
const {body: readableStream} = await fetch ( 'https://example.com' );
console. log ( await getStream (readableStream. pipeThrough (textDecoderStream))); copy
Blobs import {getStreamAsArrayBuffer} from 'get-stream' ;
const stream = fs. createReadStream ( 'unicorn.txt' );
console. log ( new Blob ([ await getStreamAsArrayBuffer (stream)])); copy
JSON streaming getStreamAsArray() can be combined with JSON streaming utilities to parse JSON incrementally.
import fs from 'node:fs' ;
import {compose as composeStreams} from 'node:stream' ;
import {getStreamAsArray} from 'get-stream' ;
import streamJson from 'stream-json' ;
import streamJsonArray from 'stream-json/streamers/StreamArray.js' ;
const stream = fs. createReadStream ( 'big-array-of-objects.json' );
console. log ( await getStreamAsArray (
composeStreams (stream, streamJson. parser (), streamJsonArray. streamArray ()),
)); copy
Benchmarks
Node.js stream (100 MB, binary)
getStream(): 142ms
text(): 139ms
getStreamAsBuffer(): 106ms
buffer(): 83ms
getStreamAsArrayBuffer(): 105ms
arrayBuffer(): 81ms
getStreamAsArray(): 24ms
stream.toArray(): 21ms
Node.js stream (100 MB, text)
getStream(): 90ms
text(): 89ms
getStreamAsBuffer(): 127ms
buffer(): 192ms
getStreamAsArrayBuffer(): 129ms
arrayBuffer(): 195ms
getStreamAsArray(): 89ms
stream.toArray(): 90ms
Web ReadableStream (100 MB, binary)
getStream(): 223ms
text(): 221ms
getStreamAsBuffer(): 182ms
buffer(): 153ms
getStreamAsArrayBuffer(): 171ms
arrayBuffer(): 155ms
getStreamAsArray(): 83ms
Web ReadableStream (100 MB, text)
getStream(): 141ms
text(): 139ms
getStreamAsBuffer(): 91ms
buffer(): 80ms
getStreamAsArrayBuffer(): 89ms
arrayBuffer(): 81ms
getStreamAsArray(): 21ms
FAQ 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, an ArrayBuffer or an 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.