# @types/pdf-thumbnail

> TypeScript definitions for pdf-thumbnail

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

## Install

```sh
npm install @types/pdf-thumbnail
pnpm add @types/pdf-thumbnail
yarn add @types/pdf-thumbnail
bun add @types/pdf-thumbnail
```

## Health

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

Positive: has types; no vulnerabilities; popular repo; extremely popular.

Warnings: low downloads; no esm support.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 1.0.4 |
| Published | 2023-11-07 |
| First published | 2020-05-05 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 4.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51390 |
| Maintainers | types |

## Links

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

## Dependencies (1)

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

## Recent versions

- 1.0.4 (latest) — 2023-11-07
- 1.0.1 (ts3.6) — 2021-07-08
- 1.0.0 (ts2.9) — 2020-05-05
- 1.0.3 — 2023-10-18
- 1.0.2 — 2023-09-24

## README

# Installation
> `npm install --save @types/pdf-thumbnail`

# Summary
This package contains type definitions for pdf-thumbnail (https://github.com/nicoFuccella/pdf-thumbnail#readme).

# Details
Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pdf-thumbnail.
## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/pdf-thumbnail/index.d.ts)
````ts
/// <reference types="node" />

declare namespace pdf {
    type Operations = "compress" | "crop" | "resize";

    interface CompressParams {
        type?: string | undefined;
        quality?: number | undefined;
    }

    interface CropParams {
        width: number;
        height: number;
        x: number;
        y: number;
        ratio?: boolean | undefined;
    }

    interface ResizeParams {
        width?: number | undefined;
        height?: number | undefined;
    }

    interface OperationsParams {
        compress: CompressParams;
        crop: CropParams;
        resize: ResizeParams;
    }

    type PDFThumbnailOptions = {
        [op in Operations]?: OperationsParams[op];
    };
}

declare function pdf(
    body: NodeJS.ReadableStream | Buffer | string,
    options?: pdf.PDFThumbnailOptions,
): Promise<NodeJS.ReadableStream>;

export = pdf;

````

### Additional Details
 * Last updated: Tue, 07 Nov 2023 09:09:39 GMT
 * Dependencies: [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [Kirill Koshil](https://github.com/koshilki).

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