# byte-stream

> through stream that buffers streams into batches limited by a cumulative byte size limit

Latest version **2.1.0** (published 2014-07-27) · BSD-2-Clause license · 0 weekly downloads

## Install

```sh
npm install byte-stream
pnpm add byte-stream
yarn add byte-stream
bun add byte-stream
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2014-07-27 |
| First published | 2013-09-07 |
| Weekly downloads | 0 |
| License | BSD-2-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Known vulnerabilities | 0 (+2 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 22 |
| Author | max ogden |
| Maintainers | maxogden, mafintosh |

## Links

- npm: https://www.npmjs.com/package/byte-stream
- Repository: https://github.com/maxogden/byte-stream
- Issues: https://github.com/maxogden/byte-stream/issues
- npm.io page: https://npm.io/package/byte-stream

## Dependencies (2)

- [debug](https://npm.io/package/debug.md) ^1.0.4
- [readable-stream](https://npm.io/package/readable-stream.md) ~1.1.10

## Recent versions

- 2.1.0 (latest) — 2014-07-27
- 2.0.3 — 2014-06-02
- 2.0.2 — 2014-04-10
- 2.0.1 — 2014-04-09
- 2.0.0 — 2014-04-09
- 1.1.0 — 2014-04-09
- 1.0.0 — 2014-02-14
- 0.0.1 — 2013-09-07

## README

# byte-stream

A stream that you write buffers or strings to, and it emits buffers at or bellow your byte limit.

[![NPM](https://nodei.co/npm/byte-stream.png)](https://nodei.co/npm/byte-stream/)

## usage

```
var batcher = require('byte-stream')

// batch until a byte limit
var batchedStream = batcher(limit);

// or batch until a given time or byte limit
var batchedStream = batcher({time:1000, limit:limit})
```

Returns a stream. You can `.pipe` other streams to it or `.write` them yourself (if you `.write` don't forget to `.end`)

For more examples of usage see `test.js`


### license

BSD

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

  * Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
  * Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in the
    documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

---
_Source: https://npm.io/package/byte-stream · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._