# @types/iltorb

> TypeScript definitions for iltorb

Latest version **2.3.6** (published 2023-11-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/iltorb
pnpm add @types/iltorb
yarn add @types/iltorb
bun add @types/iltorb
```

## Health

**Score 45/100 (D)** — status: abandoned.

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

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 2.3.6 |
| Published | 2023-11-07 |
| First published | 2017-11-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 5.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51447 |
| Maintainers | types |

## Links

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

## Dependencies (1)

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

## Recent versions

- 2.3.6 (latest) — 2023-11-07
- 2.3.3 (ts3.6) — 2021-07-08
- 2.3.2 (ts3.0) — 2020-05-19
- 2.3.0 (ts2.2) — 2018-08-18
- 2.0.0 (ts2.0) — 2017-11-21
- 2.3.5 — 2023-10-18
- 2.3.4 — 2023-09-26
- 2.3.1 — 2020-05-15
- 2.0.1 — 2017-12-20

## README

# Installation
> `npm install --save @types/iltorb`

# Summary
This package contains type definitions for iltorb (https://github.com/MayhemYDG/iltorb).

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

import { Transform } from "stream";

export type BrotliMode = 0 | 1 | 2;
export type BrotliCompressionQuality = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11;

export interface BrotliEncodeParams {
    disable_literal_context_modeling?: boolean | undefined;
    lgblock?: number | undefined;
    lgwin?: number | undefined;
    /** @default 0 */
    mode?: BrotliMode | undefined;
    /** @default 11 */
    quality?: BrotliCompressionQuality | undefined;
    size_hint?: number | undefined;
}

export interface BrotliFlushable {
    flush(): void;
}

export type IltorbCallback = (err: Error | null | undefined, output: Buffer) => void;

export function compress(buffer: Buffer, options: BrotliEncodeParams, callback: IltorbCallback): void;
export function compress(buffer: Buffer, callback: IltorbCallback): void;
export function compress(buffer: Buffer, options?: BrotliEncodeParams): Promise<Buffer>;

export function decompress(buffer: Buffer, callback: IltorbCallback): void;
export function decompress(buffer: Buffer): Promise<Buffer>;

export function compressSync(buffer: Buffer, options?: BrotliEncodeParams): Buffer;
export function decompressSync(buffer: Buffer): Buffer;

export function compressStream(options?: BrotliEncodeParams): Transform & BrotliFlushable;
export function decompressStream(): Transform;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 03:09:37 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [Arturas Molcanovas](https://github.com/Alorel), and [Francis Gulotta](https://github.com/reconbot).

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