Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

buffer-queue

Package Overview
Dependencies
Maintainers
1
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

buffer-queue

fast buffer storage

  • 1.0.0
  • latest
  • Source
  • npm
  • Socket score

Version published
Maintainers
1
Created
Source

buffer-queue

Build Status Build Status

A fast buffer store, for queueing up buffer chunks to later drain as a full buffer for streams. Faster than Buffer.concat on every chunk.

Install

npm install buffer-queue

Usage

Example of a transform stream that only writes downstream 1MB at a time, storing up buffers in the buffer store.

var Transform = require("stream").Transform;
var util = require("util");
var Store = require("buffer-queue");

/**
 * Transform stream that limits writes to 1MB at a time
 */
function ThrottleStream (limit) {
  this.limit = limit || 1024 * 1024;
  this.store = new Store();
  Transform.call(this);
}
util.inherits(ThrottleStream, Transform);

ThrottleStream.prototype._transform = function (chunk, enc, callback) {
  this.store.push(chunk);
  var data;

  // While we have more in our store than the limit, then push
  // out a chunk
  while (this.store.length() > this.limit && data = this.store.shift(this.limit)) {
    this.push(data);
  }
  callback();
};

ThrottleStream.prototype._flush = function (callback) {
  var data;
  while (data = this.store.shift(this.limit)) {
    this.push(data);
  }
  callback();
};

API

BufferStore()

Constructor for a buffer store.

store.push(buffer)

Pushes a buffer to the store.

store.shift(n)

Returns the first n bytes of the entire buffer store and removes from the store.

store.empty()

Empties the entire internal buffer store.

store.length()

Returns the length of the internal buffer store in bytes.

store.drain()

Empties and returns the internal buffer store. Use store.empty() if you are not interested in the return value.

Testing

npm test

License

MIT License, Copyright (c) 2015 Jordan Santell

Keywords

FAQs

Package last updated on 13 Mar 2015

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc