76 lines
1.6 KiB
Markdown
76 lines
1.6 KiB
Markdown
|
# gzip-size
|
||
|
|
|
||
|
|
> Get the gzipped size of a string or buffer
|
||
|
|
|
||
|
|
## Install
|
||
|
|
|
||
|
|
```sh
|
||
|
|
npm install gzip-size
|
||
|
|
```
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
import {gzipSize, gzipSizeSync} from 'gzip-size';
|
||
|
|
|
||
|
|
const text = 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Aenean commodo ligula eget dolor. Aenean massa. Cum sociis natoque penatibus et magnis dis parturient montes, nascetur ridiculus mus.';
|
||
|
|
|
||
|
|
console.log(text.length);
|
||
|
|
//=> 191
|
||
|
|
|
||
|
|
console.log(gzipSizeSync(text));
|
||
|
|
//=> 78
|
||
|
|
```
|
||
|
|
|
||
|
|
## API
|
||
|
|
|
||
|
|
### gzipSize(input, options?)
|
||
|
|
|
||
|
|
Returns a `Promise<number>` with the size.
|
||
|
|
|
||
|
|
### gzipSizeSync(input, options?)
|
||
|
|
|
||
|
|
Returns the size.
|
||
|
|
|
||
|
|
#### input
|
||
|
|
|
||
|
|
Type: `string | Buffer`
|
||
|
|
|
||
|
|
#### options
|
||
|
|
|
||
|
|
Type: `object`
|
||
|
|
|
||
|
|
Any [`zlib` option](https://nodejs.org/api/zlib.html#zlib_class_options).
|
||
|
|
|
||
|
|
### gzipSizeFromFile(path, options?)
|
||
|
|
|
||
|
|
Returns a `Promise<number>` with the size of the file.
|
||
|
|
|
||
|
|
#### path
|
||
|
|
|
||
|
|
Type: `string`
|
||
|
|
|
||
|
|
### gzipSizeFromFileSync(path, options?)
|
||
|
|
|
||
|
|
Returns the size of the file.
|
||
|
|
|
||
|
|
### gzipSizeStream(options?)
|
||
|
|
|
||
|
|
Returns a [`stream.PassThrough`](https://nodejs.org/api/stream.html#stream_class_stream_passthrough). The stream emits a `gzip-size` event and has a `gzipSize` property.
|
||
|
|
|
||
|
|
## Related
|
||
|
|
|
||
|
|
- [gzip-size-cli](https://github.com/sindresorhus/gzip-size-cli) - CLI for this module
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
<div align="center">
|
||
|
|
<b>
|
||
|
|
<a href="https://tidelift.com/subscription/pkg/npm-gzip-size?utm_source=npm-gzip-size&utm_medium=referral&utm_campaign=readme">Get professional support for this package with a Tidelift subscription</a>
|
||
|
|
</b>
|
||
|
|
<br>
|
||
|
|
<sub>
|
||
|
|
Tidelift helps make open source sustainable for maintainers while giving companies<br>assurances about security, maintenance, and licensing for their dependencies.
|
||
|
|
</sub>
|
||
|
|
</div>
|