# @types/save-pixels

> TypeScript definitions for save-pixels

Latest version **2.3.5** (published 2025-10-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install @types/save-pixels
pnpm add @types/save-pixels
yarn add @types/save-pixels
bun add @types/save-pixels
```

## Health

**Score 65/100 (B)** — status: stable.

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

Warnings: low downloads; no esm support.

## Facts

| | |
|---|---|
| Version | 2.3.5 |
| Published | 2025-10-24 |
| First published | 2021-04-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 3.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 51379 |
| Maintainers | types |

## Links

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

## Dependencies (2)

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

## Recent versions

- 2.3.5 (latest) — 2025-10-24
- 2.3.4 (ts5.1) — 2023-11-07
- 2.3.2 (ts4.3) — 2021-07-06
- 2.3.1 (ts3.5) — 2021-05-10
- 2.3.3 — 2023-10-18
- 2.3.0 — 2021-04-22

## README

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

# Summary
This package contains type definitions for save-pixels (https://github.com/mikolalysenko/save-pixels#readme).

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

import { NdArray } from "ndarray";
import Stream = require("stream");

// Function overloads. Most types return a Stream, except 'canvas'. Quality option only available for
// JPEG format. See https://www.npmjs.com/package/save-pixels#requiresave-pixelsarray-type-options.
declare function savePixels(array: NdArray, type: "png" | "gif"): Stream;
declare function savePixels(array: NdArray, type: "canvas"): HTMLCanvasElement;
declare function savePixels(array: NdArray, type: "jpeg" | "jpg", options?: { quality?: number | undefined }): Stream;

export = savePixels;

````

### Additional Details
 * Last updated: Fri, 24 Oct 2025 04:02:41 GMT
 * Dependencies: [@types/ndarray](https://npmjs.com/package/@types/ndarray), [@types/node](https://npmjs.com/package/@types/node)

# Credits
These definitions were written by [Don McCurdy](https://github.com/donmccurdy).

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