Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
get-stream
Advanced tools
The get-stream npm package is a utility that allows you to get a stream as a string, buffer, or array. It is useful for converting streams into a more usable form in Node.js applications.
Get stream as a string
This feature allows you to convert a readable stream into a string. It is useful when you want to process the contents of a file or any readable stream as a string.
const getStream = require('get-stream');
const fs = require('fs');
(async () => {
const stream = fs.createReadStream('file.txt');
const data = await getStream(stream);
console.log(data);
})();
Get stream as a buffer
This feature allows you to convert a readable stream into a buffer. It is useful when you need to handle binary data from streams.
const getStream = require('get-stream');
const fs = require('fs');
(async () => {
const stream = fs.createReadStream('file.txt');
const data = await getStream.buffer(stream);
console.log(data);
})();
Get stream as an array
This feature allows you to convert a readable stream into an array of values. It is useful when you want to process data from a stream in chunks or lines.
const getStream = require('get-stream');
const fs = require('fs');
(async () => {
const stream = fs.createReadStream('file.txt');
const data = await getStream.array(stream);
console.log(data);
})();
concat-stream is a writable stream that concatenates data and calls a callback with the result. It is similar to get-stream but uses a callback pattern instead of promises.
Buffer List (bl) is a storage object for collections of Node Buffers, which can be easily read and written. It is similar to get-stream's buffer functionality but offers more features for manipulating the buffer list.
stream-to-promise converts a Node.js stream into a promise, which is resolved when the 'finish' event is emitted. It is similar to get-stream but focuses on the 'finish' event rather than collecting the stream's data.
Get a stream as a string, buffer, or array
$ npm install --save get-stream
const fs = require('fs');
const getStream = require('get-stream');
const stream = fs.createReadStream('unicorn.txt');
getStream(stream).then(str => {
console.log(str);
/*
,,))))))));,
__)))))))))))))),
\|/ -\(((((''''((((((((.
-*-==//////(('' . `)))))),
/|\ ))| o ;-. '((((( ,(,
( `| / ) ;))))' ,_))^;(~
| | | ,))((((_ _____------~~~-. %,;(;(>';'~
o_); ; )))(((` ~---~ `:: \ %%~~)(v;(`('~
; ''''```` `: `:::|\,__,%% );`'; ~
| _ ) / `:|`----' `-'
______/\/~ | / /
/~;;.____/;;' / ___--,-( `;;;/
/ // _;______;'------~~~~~ /;;/\ /
// | | / ; \;;,\
(<_ | ; /',/-----' _>
\_| ||_ //~;~~~~~~~~~
`\_| (,~~
\~\
~~
*/
});
The methods returns a promise that is resolved 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.
Get the stream
as a string.
Type: string
Default: utf8
Encoding of the incoming stream.
Type: number
Default: Infinity
Maximum length of the returned string. If it exceeds this value before the stream ends, the promise will be rejected.
Get the stream
as a buffer.
It honors the maxBuffer
option as above, but it refers to byte length rather than string length.
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 encoding
is unset, it assumes an object mode stream and collects values emitted from stream
unmodified. In this case maxBuffer
refers to the number of items in the array (not the sum of their sizes).
When encoding
is set to buffer
, it collects an array of buffers. maxBuffer
refers to the summed byte lengths of every buffer in the array.
When encoding
is set to anything else, it collects an array of strings. maxBuffer
refers to the summed character lengths of every string in the array.
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.
getStream(streamThatErrorsAtTheEnd('unicorn'))
.catch(err => console.log(err.bufferedData));
// unicorn
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.
MIT © Sindre Sorhus
FAQs
Get a stream as a string, Buffer, ArrayBuffer or array
The npm package get-stream receives a total of 83,419,053 weekly downloads. As such, get-stream popularity was classified as popular.
We found that get-stream demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.