@canvas/image

中文文档
2.0.0发布于 2023/07/26MITTypeScript近 30 天下载 36.6万

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

中文使用文档
文档目录7 节
  1. 安装
  2. 使用量
  3. API 密码
  4. getImageData(image)
  5. imageFromBuffer(buffer)
  6. imageFromImageData(imageData)
  7. 抢劫

图像

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

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

安装

npm install --save @canvas/image

使用量

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,要求)
  • 返回时 ImageData 或者说 undefined

imageFromBuffer(buffer)

  • buffer (单位:千美元)Uint8Array,要求)
  • 返回时 Promise<Image>

imageFromImageData(imageData)

  • imageData (单位:千美元)ImageData,要求)
  • 返回时 Promise<Image>

抢劫

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

版本与发布记录

@canvas/image 共发布 3 个版本,首次发布于 2019/11/24;过去 12 个月发布了 0 个版本。

版本发布日期距今
2.0.0latest2023/07/263 年前
1.0.12020/03/256 年前
1.0.02019/11/246 年前

关于 @canvas/image 的常见问题

@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 和提交记录判断。