JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 272229
  • Score
    100M100P100Q176190F
  • License MIT

Returns a promise which fulfils with the supplied stream's content

Package Exports

  • stream-read-all

Readme

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.