# seal-countingstream

> seal-countingstream counts the stream length in bytes.

Latest version **1.0.1** (published 2017-02-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install seal-countingstream
pnpm add seal-countingstream
yarn add seal-countingstream
bun add seal-countingstream
```

## 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 | 1.0.1 |
| Published | 2017-02-08 |
| First published | 2017-02-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | SEAL Systems AG |
| Maintainers | manni19682 |

## Links

- npm: https://www.npmjs.com/package/seal-countingstream
- Repository: https://github.com/sealsystems/seal-countingstream
- Homepage: https://github.com/sealsystems/seal-countingstream#readme
- Issues: https://github.com/sealsystems/seal-countingstream/issues
- npm.io page: https://npm.io/package/seal-countingstream

## Recent versions

- 1.0.1 (latest) — 2017-02-08

## README

# seal-countingstream

[![CircleCI](https://circleci.com/gh/sealsystems/seal-countingstream.svg?style=svg)](https://circleci.com/gh/sealsystems/seal-countingstream)
[![AppVeyor](https://ci.appveyor.com/api/projects/status/abqaq6i5benu5p00?svg=true)](https://ci.appveyor.com/project/Plossys/seal-countingstream)

seal-countingstream counts the stream length in bytes.

## Installation

```bash
$ npm install seal-countingstream
```

## Quick start

First you need to add a reference to seal-countingstream within your application.

```javascript
const CountingStream = require('seal-countingstream');
```

Then, call the constructor function.

```javascript
const countingstream = new CountingStream();
```

CountingStream is derived from the Transform stream and can be used like any such stream. To get the number of bytes piped through, call:

```javascript
const numberOfStreamedBytes = countingstream.getCount(); // -> returns the number of bytes streamed so far
```

You can reset the counter any time.

```javascript
countingstream.resetCount();
```

It is also possible to set the counter to an arbitrary value.

```javascript
countingstream.resetCount(42);
countingstream.getCount(); // -> returns 42
```

## Running the build

To build this module use [roboter](https://www.npmjs.com/package/roboter).

```bash
$ bot
```

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