minipass-sized

WebJar for minipass-sized

License

License

ISC
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

minipass-sized
Last Version

Last Version

1.0.3
Release Date

Release Date

Type

Type

jar
Description

Description

minipass-sized
WebJar for minipass-sized
Project URL

Project URL

https://www.webjars.org
Source Code Management

Source Code Management

https://github.com/isaacs/minipass-sized

Download minipass-sized

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/minipass-sized/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>minipass-sized</artifactId>
    <version>1.0.3</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/minipass-sized/
implementation 'org.webjars.npm:minipass-sized:1.0.3'
// https://jarcasting.com/artifacts/org.webjars.npm/minipass-sized/
implementation ("org.webjars.npm:minipass-sized:1.0.3")
'org.webjars.npm:minipass-sized:jar:1.0.3'
<dependency org="org.webjars.npm" name="minipass-sized" rev="1.0.3">
  <artifact name="minipass-sized" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='minipass-sized', version='1.0.3')
)
libraryDependencies += "org.webjars.npm" % "minipass-sized" % "1.0.3"
[org.webjars.npm/minipass-sized "1.0.3"]

Dependencies

compile (1)

Group / Artifact Type Version
org.webjars.npm : minipass jar [3.0.0,4)

Project Modules

There are no modules declared in this project.

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.

Versions

Version
1.0.3