# @types/lqip-modern

> TypeScript definitions for lqip-modern

Latest version **1.1.7** (published 2023-11-21) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/lqip-modern
pnpm add @types/lqip-modern
yarn add @types/lqip-modern
bun add @types/lqip-modern
```

## 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 | 1.1.7 |
| Published | 2023-11-21 |
| First published | 2020-12-08 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 5.5 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51449 |
| Maintainers | types |

## Links

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

## Dependencies (2)

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

## Recent versions

- 1.1.7 (latest) — 2023-11-21
- 1.1.4 (ts4.3) — 2023-08-30
- 1.1.2 (ts3.6) — 2021-07-08
- 1.1.1 (ts3.3) — 2021-01-04
- 1.1.6 — 2023-11-07
- 1.1.5 — 2023-10-18
- 1.1.3 — 2023-04-26
- 1.1.0 — 2020-12-08

## README

# Installation
> `npm install --save @types/lqip-modern`

# Summary
This package contains type definitions for lqip-modern (https://github.com/transitive-bullshit/lqip-modern/).

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

import sharp = require("sharp");

declare namespace lqip {
    interface LqipResult {
        content: Buffer;
        metadata: {
            originalWidth: number;
            originalHeight: number;
            width: number;
            height: number;
            type: OutputFormat;
            dataURIBase64: string;
        };
    }

    type OutputFormat = WebpOptions["outputFormat"] | JpegOptions["outputFormat"] | JpgOptions["outputFormat"];

    type LqipOptions = WebpOptions | JpegOptions | JpgOptions | DefaultOptions;

    interface DefaultOptions {
        concurrency?: number | undefined;
        resize?: number | readonly any[] | undefined;
    }

    interface WebpOptions extends DefaultOptions {
        readonly outputFormat?: "webp" | undefined;
        readonly outputOptions?: sharp.WebpOptions | undefined;
    }
    interface JpegOptions extends DefaultOptions {
        readonly outputFormat: "jpeg";
        readonly outputOptions?: sharp.JpegOptions | undefined;
    }
    interface JpgOptions extends DefaultOptions {
        readonly outputFormat: "jpg";
        readonly outputOptions?: sharp.JpegOptions | undefined;
    }
}

declare function lqip(input: string | Buffer, options?: lqip.LqipOptions): Promise<lqip.LqipResult>;
declare function lqip(
    input: readonly string[] | readonly Buffer[],
    options?: lqip.LqipOptions,
): Promise<lqip.LqipResult[]>;

export = lqip;

````

### Additional Details
 * Last updated: Mon, 20 Nov 2023 23:36:24 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node), [@types/sharp](https://npmjs.com/package/@types/sharp)

# Credits
These definitions were written by [Yaroslav Kiliba](https://github.com/Dattaya).

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