# @canvas/image 中文文档

规范地址：https://npmcn.com/package/%40canvas/image/

版本：2\.0\.0
npm 元数据更新时间：2023-07-26T12:30:54.934Z
中文译文更新时间：2026-11-09T01:27:30.506Z
软件包许可：MIT

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40canvas/image
原文对照：https://npmcn.com/package/%40canvas/image/?lang=original
项目主页：https://github.com/node-gfx/image#readme
源码仓库：https://github.com/node-gfx/image

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：13.2 kB，5 个文件
- TypeScript 类型：包内自带
- Node.js 要求：\>=10
- 运行依赖：11 个
- 首次发布：2019-11-24T15:01:10.617Z
- 最新版本发布：2023-07-26T12:30:54.740Z
- 近 30 天下载量：366265（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

一个 `Image` 用于浏览器外的使用.

## 安装

```sh
npm install @canvas/image
```

也可以使用：`pnpm add @canvas/image`、`yarn add @canvas/image`、`bun add @canvas/image`

## README

# 图像

一个 `Image` 用于浏览器外的使用.

另外,还输出一些在Node.js和浏览器中可用并带有浏览器、Webpack等包装的辅助方法.

## 安装

```sh
npm install --save @canvas/image
```

## 使用量

```js
const fs = require('fs')
const { Image, getImageData, imageFromBuffer, imageFromImageData } = require('@canvas/image')

// Traditional loading
const img = new Image()
img.src = 'image.png'
img.onload = () => {
  console.log(img.width)
  // => 2

  console.log(img.height)
  // => 1

  console.log(getImageData(img).data)
  // => Uint8ClampedArray [ 1, 2, 3, 4, 5, 6, 7, 8 ]
}

// From Buffer
const source = fs.readFileSync('image.png')
imageFromBuffer(source).then((img) => {
  console.log(img.width)
  // => 2

  console.log(img.height)
  // => 1

  console.log(getImageData(img).data)
  // => Uint8ClampedArray [ 1, 2, 3, 4, 5, 6, 7, 8 ]
})

// From ImageData
const data = new ImageData(new Uint8ClampedArray([1, 2, 3, 4, 5, 6, 7, 8]), 2, 1)
imageFromImageData(data).then((img) => {
  console.log(img.width)
  // => 2

  console.log(img.height)
  // => 1

  console.log(getImageData(img).data)
  // => Uint8ClampedArray [ 1, 2, 3, 4, 5, 6, 7, 8 ]
})
```

## API 密码

### `getImageData(image)`

-   `image` (单位:千美元)[`Image`](https://developer.mozilla.org/en-US/docs/Web/API/Image),要求)
-   返回时 [`ImageData`](https://developer.mozilla.org/en-US/docs/Web/API/ImageData) 或者说 `undefined`

### `imageFromBuffer(buffer)`

-   `buffer` (单位:千美元)[`Uint8Array`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Uint8Array),要求)
-   返回时 `Promise<Image>`

### `imageFromImageData(imageData)`

-   `imageData` (单位:千美元)[`ImageData`](https://developer.mozilla.org/en-US/docs/Web/API/ImageData),要求)
-   返回时 `Promise<Image>`

## 抢劫

测试是针对这一执行和克罗姆的执行,以确保我们的行为相同。 您可以通过构建测试捆绑在克罗姆进行测试(`npm run build`),旋转本地网络服务器,然后打开 `test.html`。 。 。 .

## 常见问题

### @canvas/image 是什么？

一个 Image 用于浏览器外的使用\.

### 如何安装 @canvas/image？

在项目目录运行 npm install @canvas/image，或使用 pnpm add / yarn add / bun add。

### @canvas/image 支持 TypeScript 吗？

支持。包内自带 TypeScript 类型声明（package\.json 声明了 types 入口），安装后即可获得类型提示，无需再安装 @types 包。

### @canvas/image 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=10。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @canvas/image 可以商用吗？

@canvas/image 使用 MIT 许可。宽松许可：允许商业使用、修改和再分发，通常只需在分发时保留原版权与许可声明。以上为概括，不构成法律意见，请以许可原文为准。

### @canvas/image 的下载量有多少？

根据 npm 官方下载统计，@canvas/image 在 2026/10/09 – 2026/11/07 这 30 天内被下载 366,265 次，日均约 12,209 次。下载量会把 CI 构建、镜像同步和作为其他包依赖的安装一并计入，适合横向比较热度，不能直接等同于使用人数。

### @canvas/image 还在维护吗？

最新版本 2\.0\.0 发布于 2023/07/26（3 年前）；至今共发布 3 个版本，其中过去 12 个月发布了 0 个；首次发布于 2019/11/24。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。