it-buffer-stream
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.2 • Public • Published

    it-buffer-stream

    [Build status Coverage Status Dependencies Status

    An async iterable that emits buffers containing bytes up to a certain length

    Install

    $ npm install --save it-buffer-stream

    Usage

    const totalLength = //... a big number
    
    // all options are optional, defaults are shown
    const options = {
      chunkSize: 4096, // how many bytes will be in each buffer
      collector: (buffer) => {
        // will be called as each buffer is generated. the final buffer
        // may be smaller than `chunkSize`
      },
      generator: async (size) => {
        // return a promise that resolves to a buffer of length `size`
        //
        // if omitted, `Promise.resolve(crypto.randomBytes(size))` will be used
      }
    }
    
    let buffers = []
    
    for await (buf of bufferStream(totalLength, options)) {
      buffers.push(buf)
    }
    
    // `buffers` is an array of Buffers the combined length of which === totalLength

    Keywords

    none

    Install

    npm i it-buffer-stream

    DownloadsWeekly Downloads

    190

    Version

    2.0.2

    License

    ISC

    Unpacked Size

    6.91 kB

    Total Files

    7

    Last publish

    Collaborators

    • achingbrain