gzip-size/index.d.ts

import {Buffer} from 'node:buffer';
import {PassThrough as PassThroughStream} from 'node:stream';
import {ZlibOptions} from 'node:zlib';

export type Options = ZlibOptions;

export interface GzipSizeStream extends PassThroughStream {
	/**
	Contains the gzip size of the stream after it is finished. Since this happens asynchronously, it is recommended you use the `gzip-size` event instead.
	*/
	gzipSize?: number;

	addListener(event: 'gzip-size', listener: (size: number) => void): this;
	addListener(
		event: string | symbol,
		listener: (...args: any[]) => void
	): this;
	on(event: 'gzip-size', listener: (size: number) => void): this;
	on(event: string | symbol, listener: (...args: any[]) => void): this;
	once(event: 'gzip-size', listener: (size: number) => void): this;
	once(event: string | symbol, listener: (...args: any[]) => void): this;
	removeListener(event: 'gzip-size', listener: (size: number) => void): this;
	removeListener(
		event: string | symbol,
		listener: (...args: any[]) => void
	): this;
	off(event: 'gzip-size', listener: (size: number) => void): this;
	off(event: string | symbol, listener: (...args: any[]) => void): this;
	emit(event: 'gzip-size', size: number): boolean;
	emit(event: string | symbol, ...args: any[]): boolean;
	prependListener(event: 'gzip-size', listener: (size: number) => void): this;
	prependListener(
		event: string | symbol,
		listener: (...args: any[]) => void
	): this;
	prependOnceListener(
		event: 'gzip-size',
		listener: (size: number) => void
	): this;
	prependOnceListener(
		event: string | symbol,
		listener: (...args: any[]) => void
	): this;
}

/**
Get the gzipped size of a string or buffer.

@returns The gzipped size of `input`.

@example
```
import {gzipSize} 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(await gzipSize(text));
//=> 78
```
*/
export function gzipSize(input: string | Buffer, options?: Options): Promise<number>;

/**
Synchronously get the gzipped size of a string or buffer.

@returns The gzipped size of `input`.

@example
```
import {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
```
*/
export function gzipSizeSync(input: string | Buffer, options?: Options): number;

/**
Get the gzipped size of a file.

@returns The size of the file.
*/
export function gzipSizeFromFile(filePath: string, options?: Options): Promise<number>;

/**
Synchronously get the gzipped size of a file.

@returns The size of the file.
*/
export function gzipSizeFromFileSync(filePath: string, options?: Options): number;

/**
@returns A stream that emits a `gzip-size` event and has a `gzipSize` property.
*/
export function gzipSizeStream(options?: Options): GzipSizeStream;