Get a stream as a string, buffer, or array
$ npm install --save get-stream
const fs = ;const getStream = ;const stream = fs;;
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.
stream as a string.
Encoding of the incoming stream.
Maximum length of the returned string. If it exceeds this value before the stream ends, the promise will be rejected.
stream as a buffer.
It honors the
maxBuffer option as above, but it refers to byte length rather than string length.
stream as an array of values.
It honors both the
encoding options. The behavior changes slightly based on the encoding chosen:
encodingis unset, it assumes an object mode stream and collects values emitted from
streamunmodified. In this case
maxBufferrefers to the number of items in the array (not the sum of their sizes).
encodingis set to
buffer, it collects an array of buffers.
maxBufferrefers to the summed byte lengths of every buffer in the array.
encodingis set to anything else, it collects an array of strings.
maxBufferrefers 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.
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
- get-stdin - Get stdin as a string or buffer
MIT © Sindre Sorhus