async-iterator-buffer-stream
v1.0.0
Published
An async iterator that emits buffers containing bytes up to a certain length
Downloads
11
Readme
async-iterator-buffer-stream
An async iterator that emits buffers containing bytes up to a certain length
Install
$ npm install --save async-iterator-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