stream-read-all

5.0.2 • Public • Published

view on npm npm module downloads Gihub repo dependents Gihub package dependents Node.js CI js-standard-style

stream-read-all

Returns a promise which fulfils with the supplied stream's content. Supports any Readable stream as input in either regular or object mode.

For example, this script...

import { streamReadAll } from 'stream-read-all'
const readable = await streamReadAll(process.stdin)
console.log(readable.toString())

...prints this output.

$ echo Hello | node example.js
Hello

The above streamReadAll function returns either a Buffer in regular mode or an array of objects in object mode. Alternatively, you can use streamReadText which is identical to the above except it returns text. The second argument is optional, specifying the character encoding to use (as in the buffer.toString() first argument). The default value is 'utf8'.

import { streamReadText } from 'stream-read-all'
const readable = fs.createReadStream('./package.json')
const text = await streamReadText(readable, 'hex')
console.log(text)
// prints the package.json file content in hex format

© 2017-25 Lloyd Brookes opensource@75lb.com.

Package Sidebar

Install

npm i stream-read-all

Weekly Downloads

259,991

Version

5.0.2

License

MIT

Unpacked Size

6.38 kB

Total Files

5

Last publish

Collaborators

  • 75lb