1.0.1 • Published 1 year ago

stream-chunkifier v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

stream-chunkifier

Impressed by stream-chunker another stream chunker which chunks incoming stream into evenly sized chunks using stream simplified construction, no dependency on through2.

TODO: Add support to chunk sterams by delimter

Install

$ npm install stream-chunkifier

Usage

const {sizeChunkifier} = require('stream-chunkifier');
const chunkify = sizeChunkifier(8)
const readSream=someHowGetReadStream() // Eg fs.createReadStream('filepath')

readStream
.pipe(chunkify)
.pipe(consumerExpects8ByteChunks());

API

const {sizeChunkifier} = require('stream-chunkifier');
const chunkify = sizeChunkifier(chunkSize,[options])

Returns a new chunker. Chunker is a duplex (transform) stream, regardless of incoming chunk sizes, it emits evenly sized chunks. The last chunk could be smaller.

  • chunkSize: integer - Size in bytes of the desired chunks.
  • options: {flushLastOddChunk:bool} - options argument is optional. when flushLastOddChunk is false it won't flush the last remaining chunk. By default it is true.

License

MIT