1.7 KiB
1.7 KiB
@vates/read-chunk
Read a chunk of a Node stream
Install
Installation of the npm package:
> npm install --save @vates/read-chunk
Usage
readChunk(stream, [size])
- returns the next available chunk of data
- like
stream.read(), a number of bytes can be specified - returns with less data than expected if stream has ended
- returns
nullif the stream has ended and no data has been read
import { readChunk } from '@vates/read-chunk'
;(async () => {
let chunk
while ((chunk = await readChunk(stream, 1024)) !== null) {
// do something with chunk
}
})()
readChunkStrict(stream, [size])
Similar behavior to readChunk but throws if the stream ended before the requested data could be read.
import { readChunkStrict } from '@vates/read-chunk'
const chunk = await readChunkStrict(stream, 1024)
Contributions
Contributions are very welcomed, either on the documentation or on the code.
You may:
- report any issue you've encountered;
- fork and create a pull request.