# @types/stream-meter

> TypeScript definitions for stream-meter

Latest version **1.0.0** (published 2024-10-23) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/stream-meter
pnpm add @types/stream-meter
yarn add @types/stream-meter
bun add @types/stream-meter
```

## Health

**Score 55/100 (C)** — status: stable.

Positive: has types; no vulnerabilities; high maintenance score; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: stale.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2024-10-23 |
| First published | 2016-05-17 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51444 |
| Maintainers | types |

## Links

- npm: https://www.npmjs.com/package/@types/stream-meter
- Repository: https://github.com/DefinitelyTyped/DefinitelyTyped
- Homepage: https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/stream-meter
- npm.io page: https://npm.io/package/@types/stream-meter

## Dependencies (1)

- [@types/node](https://npm.io/package/@types/node.md) *

## Recent versions

- 1.0.0 (latest) — 2024-10-23
- 0.0.25 (ts4.7) — 2023-11-07
- 0.0.22 (ts3.5) — 2019-10-15
- 0.0.24 — 2023-10-18
- 0.0.23 — 2023-09-25
- 0.0.21 — 2017-08-21
- 0.0.20 — 2017-07-25
- 0.0.19 — 2016-09-19
- 0.0.18 — 2016-07-14
- 0.0.17-alpha — 2016-07-08
- 0.0.16-alpha — 2016-07-04
- 0.0.15-alpha — 2016-07-02
- 0.0.14-alpha — 2016-07-02
- 0.0.13-alpha — 2016-07-01
- 0.0.12-alpha — 2016-05-25
- … 3 more at https://npm.io/package/@types/stream-meter/versions

## README

# Installation
> `npm install --save @types/stream-meter`

# Summary
This package contains type definitions for stream-meter (https://github.com/brycebaril/node-stream-meter).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/stream-meter.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/stream-meter/index.d.ts)
````ts
/// <reference types="node" />

import { Transform } from "stream";

declare namespace m {
    interface StreamMeterConstruct {
        (
            /**
             * Size (in bytes) to trigger the stream to abort.
             * It will complete whatever frame it aborted in, so the size streamed
             * will still be >= size but no more than size + highWaterMark
             * @default Number.MAX_VALUE
             */
            maxBytes?: number,
        ): StreamMeter;

        new(
            /**
             * Size (in bytes) to trigger the stream to abort.
             * It will complete whatever frame it aborted in, so the size streamed
             * will still be >= size but no more than size + highWaterMark
             * @default Number.MAX_VALUE
             */
            maxBytes?: number,
        ): StreamMeter;
    }

    interface StreamMeter extends Transform {
        /**
         * Number of bytes handled and passed through the meter.
         */
        bytes: number;

        /**
         * Size (in bytes) to trigger the stream to abort.
         * It will complete whatever frame it aborted in, so the size streamed
         * will still be >= size but no more than size + highWaterMark
         * @default Number.MAX_VALUE
         */
        maxBytes: number;
    }
}

declare const m: m.StreamMeterConstruct;

export = m;

````

### Additional Details
 * Last updated: Wed, 23 Oct 2024 02:32:18 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [TANAKA Koichi](https://github.com/mugeso).

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