[@asset-toolkit/image-compression](README.md) / Exports

# @asset-toolkit/image-compression

## Table of contents

### Type aliases

- [options](modules.md#options)
- [props](modules.md#props)
- [returns](modules.md#returns)

### Functions

- [default](modules.md#default)

## Type aliases

### options

Ƭ **options**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `jpg` | `any` |
| `plugins` | `any`[] \| `boolean` |
| `png` | { `dithering`: `number` \| `boolean` ; `posterize`: `number` ; `quality`: [`number`, `number`] ; `speed`: `number` ; `strip`: `boolean` ; `verbose`: `boolean`  } \| `any` |

#### Defined in

index.d.ts:1

___

### props

Ƭ **props**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `pathIn?` | `string` |
| `pathOut` | `string` |

#### Defined in

index.d.ts:13

___

### returns

Ƭ **returns**: `Object`

#### Type declaration

| Name | Type |
| :------ | :------ |
| `pathOut` | `string` |

#### Defined in

index.d.ts:17

## Functions

### default

▸ `Const` **default**(`_props`, `_options?`): `Promise`<[`returns`](modules.md#returns)\>

#### Parameters

| Name | Type |
| :------ | :------ |
| `_props` | [`props`](modules.md#props) |
| `_options?` | [`options`](modules.md#options) |

#### Returns

`Promise`<[`returns`](modules.md#returns)\>

#### Defined in

index.d.ts:20