avancement planning
This commit is contained in:
+11
-9
@@ -1,18 +1,20 @@
|
||||
# minipass-sized
|
||||
|
||||
A Minipass stream that raises an error if you get a different number of
|
||||
bytes than expected.
|
||||
A Minipass stream that raises an error if you get a different
|
||||
number of bytes than expected.
|
||||
|
||||
## USAGE
|
||||
|
||||
Use just like any old [minipass](http://npm.im/minipass) stream, but
|
||||
provide a `size` option to the constructor.
|
||||
Use just like any old [minipass](http://npm.im/minipass) stream,
|
||||
but provide a `size` option to the constructor.
|
||||
|
||||
The `size` option must be a positive integer, smaller than
|
||||
`Number.MAX_SAFE_INTEGER`.
|
||||
|
||||
```js
|
||||
const MinipassSized = require('minipass-sized')
|
||||
```ts
|
||||
import { MinipassSized } from 'minipass-sized'
|
||||
// or:
|
||||
// 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 })
|
||||
@@ -23,6 +25,6 @@ stream.on('error', er => {
|
||||
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.
|
||||
Caveats: this does not work with `objectMode` streams, and will
|
||||
throw a `TypeError` from the constructor if the size argument is
|
||||
missing or invalid.
|
||||
|
||||
Reference in New Issue
Block a user