JSPM

truncate-stream

1.0.2
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • 0
  • Score
    100M100P100Q51815F
  • License MIT

stream which truncates input after N bytes

Package Exports

  • truncate-stream

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (truncate-stream) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

truncate-stream

A Transform stream which truncates input after N bytes. Warning since it truncates at a byte marker it could corrupt the last char of a text stream with doublebyte chars.

npm install truncate-stream

When the threshold has been reached it forcibly ends the stream rather than just ignoring any further bytes. That works for the use case I had but could potentially cause socket hangup errors with http streams.

Usage

Get 1KB of randomness from randstream which otherwise would continue indefinitely.

var RandStream = require('randstream');
var concat = require('concat-stream');
var TruncateStream = require('truncate-stream');

var random = new RandStream();
var truncate = new TruncateStream({maxBytes: 1024});

random.pipe(truncate).pipe(concat(function(data) {
  // data.length === 1024
});

Licence

MIT