# brotli-size

> Get the brotli compressed size of a string or buffer

Latest version **4.0.0** (published 2019-08-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install brotli-size
pnpm add brotli-size
yarn add brotli-size
bun add brotli-size
```

## 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 | 4.0.0 |
| Published | 2019-08-08 |
| First published | 2016-05-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >= 10.16.0 |
| Dependencies | 1 |
| Unpacked size | 136.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 20 |
| Author | Erwin Mombay |
| Maintainers | erwinmombay |
| Keywords | size, tool, brotli, compressed |

## Links

- npm: https://www.npmjs.com/package/brotli-size
- Repository: https://github.com/erwinmombay/brotli-size
- npm.io page: https://npm.io/package/brotli-size

## Dependencies (1)

- [duplexer](https://npm.io/package/duplexer.md) 0.1.1

## Alternatives

- [exif-parser](https://npm.io/package/exif-parser.md) — 3.8M weekly downloads
- [vite-plugin-compression](https://npm.io/package/vite-plugin-compression.md) — 569.5K weekly downloads
- [pica](https://npm.io/package/pica.md) — 442.4K weekly downloads
- [@reportportal/client-javascript](https://npm.io/package/@reportportal/client-javascript.md) — 408.8K weekly downloads
- [@tldraw/state](https://npm.io/package/@tldraw/state.md) — 316.0K weekly downloads

## Recent versions

- 4.0.0 (latest) — 2019-08-08
- 3.0.1 — 2019-07-17
- 3.0.0 — 2019-07-16
- 1.0.0 — 2019-07-16
- 0.1.0 — 2019-05-06
- 0.0.3 — 2018-08-04
- 0.0.2 — 2018-03-13
- 0.0.1 — 2016-05-15

## README

brotli-size

> Get the brotli compressed size of a string or buffer.

## Install

```
$ npm install --save brotli-size
```

## Usage

```js
var brotliSize = require('brotli-size');
var str = 'Lorem ipsum dolor sit amet, consectetur adipiscing elit. Etiam feugiat, mauris non aliquam pretium, libero nulla ultrices lacus, nec varius est purus sit amet dolor.';

console.log(str.length); // 165

console.log(brotliSize.sync(str)); // 118
```

## API

### brotliSize.sync(input)

#### input

Type: `string`, `buffer`

### brotliSize.stream()

Returns a passthrough stream. The stream emits a `brotli-size` event and
has a `brotliSize` property.
## Related

- [gzip-size](https://github.com/sindresorhus/gzip-size) - Heavily inspired by
this module. Thank you for the inspiration!

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