History

Brodin d6d85f2ffe adding local files for running this....locally		2024-09-23 19:05:38 -04:00
..
test	adding local files for running this....locally	2024-09-23 19:05:38 -04:00
.gitignore	adding local files for running this....locally	2024-09-23 19:05:38 -04:00
index.js	adding local files for running this....locally	2024-09-23 19:05:38 -04:00
LICENSE	adding local files for running this....locally	2024-09-23 19:05:38 -04:00
package-lock.json	adding local files for running this....locally	2024-09-23 19:05:38 -04:00
package.json	adding local files for running this....locally	2024-09-23 19:05:38 -04:00
README.md	adding local files for running this....locally	2024-09-23 19:05:38 -04:00

README.md

minipass-sized

A Minipass stream that raises an error if you get a different number of bytes than expected.

USAGE

Use just like any old minipass stream, but provide a size option to the constructor.

The size option must be a positive integer, smaller than Number.MAX_SAFE_INTEGER.

const MinipassSized = require('minipass-sized')
// figure out how much data you expect to get
const expectedSize = +headers['content-length']
const stream = new MinipassSized({ size: expectedSize })
stream.on('error', er => {
  // if it's the wrong size, then this will raise an error with
  // { found: <number>, expect: <number>, code: 'EBADSIZE' }
})
response.pipe(stream)

Caveats: this does not work with objectMode streams, and will throw a TypeError from the constructor if the size argument is missing or invalid.