@discourse/png

中文文档
3.1.1发布于 2026/05/08Apache-2.0TypeScriptES Module零依赖近 30 天下载 8.7万

Wasm png 编码器和解码器支持浏览器. 从Squoosh App重新包装.

中文使用文档
文档目录5 节
  1. 安装
  2. 使用量
  3. 解码(data: ArrayBuffer, options? ): {位深度? : 8\ 16} : 保证<图像数据>…
  4. encode(数据:ImageData QQ ImageDataRGBA16), 选项: {位深度? : 8\ 16}…
  5. 手工 WASM 初始化( 不推荐)

翻译:

npm version

浏览器中用于编码和解码PNG图像的简单体验. 由WebAssembly提供电力.

使用 生锈 PNG 箱子。 。 。 .

A 类 积分 软件包。 源自 斯库什语Name 应用.

安装

npm install --save @jsquash/png
# Or your favourite package manager alternative

使用量

注意 : 您需要手动将代码目录中的被点文件包含在内, 或者使用 WebPack 或 Rollup 这样的捆绑器将它们包含在您的应用程序/ 服务器中 .

解码(data: ArrayBuffer, options? ): {位深度? : 8\ 16} : 保证<图像数据> {图像数据DataRGBA16>

将 PNG 二进制阵列缓冲解码为原始图像数据 . 默认情况下,它会解码为8位的RGBA图像数据. 若为 options.bitDepth 设置为 16,它解码为 16-位 RGBA 图像数据.

数据

类型 : ArrayBuffer

选项(可选)

类型 : object

  • bitDepth (可选) : 8 | 16 - 输出想要的比特深度。 默认为 8。 。 。 .

示例

import { decode } from '@jsquash/png';

const formEl = document.querySelector('form');
const formData = new FormData(formEl);
// Decode to 8-bit RGBA
const imageData8bit = await decode(await formData.get('image').arrayBuffer());
// Decode to 16-bit RGBA
const imageData16bit = await decode(await formData.get('image').arrayBuffer(), { bitDepth: 16 });

encode(数据:ImageData QQ ImageDataRGBA16), 选项: {位深度? : 8\ 16}: 保证

你也许想使用 翻译: 软件包。 它既能从原始图像数据直接优化并编码到PNG(只有8位图像).

将原始的 RGB 图像数据编码为 PNG 格式并解析为二进制数据的 ArrayBuffer .

可选择指定输出 PNG 的位深 。 默认为8位.

数据

类型 : ImageData 或用于 16 位图像 { data: Uint16Array; width: number; height: number; }

示例

import { encode } from '@jsquash/png';

async function loadImage(src) {
  const img = document.createElement('img');
  img.src = src;
  await new Promise(resolve => img.onload = resolve);
  const canvas = document.createElement('canvas');
  [canvas.width, canvas.height] = [img.width, img.height];
  const ctx = canvas.getContext('2d');
  ctx.drawImage(img, 0, 0);
  return ctx.getImageData(0, 0, img.width, img.height);
}

const rawImageData = await loadImage('/example.jpg');
const pngBuffer = await encode(rawImageData);

有 16 位图像数据的示例

import { encode } from '@jsquash/png';

async function create16bitImage(src) {
  const pixels = new Uint16Array(4 * 256 * 256);
  for (let i = 0; i < pixels.length; i += 4) {
    pixels[i] = Math.floor(Math.random() * 65535); // R
    pixels[i + 1] = Math.floor(Math.random() * 65535); // G
    pixels[i + 2] = Math.floor(Math.random() * 65535); // B
    pixels[i + 3] = 65535; // A
  }
  return {
    data: pixels,
    width: 256,
    height: 256,
  };
}

const rawImageData = await create16bitImage();
const png16bitBuffer = await encode(rawImageData, { bitDepth: 16 });

在大多数情况下,不需要手动将所提供的WebAssembly模块关闭. 生成的胶体代码会照顾到这一点,并支持大多数的网络捆绑器.

出现这种情况的一个情况是,在Cloudflare工人中使用模块(更多信息请参见 README) (中文(简体) ).

这个 encode 财务报告和审定财务报表 decode 模块两个导出 an init 函数,用于手动加载原模块.

import decode, { init as initPngDecode } from '@jsquash/png/decode';

initPngDecode(WASM_MODULE); // The `WASM_MODULE` variable will need to be sourced by yourself and passed as an ArrayBuffer.
const image = await fetch('./image.png').then(res => res.arrayBuffer()).then(decode);

版本与发布记录

@discourse/png 共发布 1 个版本,首次发布于 2026/05/08;过去 12 个月发布了 1 个版本。

版本发布日期距今
3.1.1latest2026/05/086 个月前

关于 @discourse/png 的常见问题

@discourse/png 是什么?

Wasm png 编码器和解码器支持浏览器. 从Squoosh App重新包装.

如何安装 @discourse/png?

在项目目录运行 npm install @discourse/png,或使用 pnpm add / yarn add / bun add。

@discourse/png 支持 TypeScript 吗?

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

@discourse/png 支持 ESM 还是 CommonJS?

以 ES Module 形式发布,推荐使用 import 引入。在 CommonJS 项目中,Node.js 20.19+ / 22.12+ 可以直接 require() 不含顶层 await 的 ES Module,更早的版本需要改用动态 import()。

@discourse/png 可以商用吗?

@discourse/png 使用 Apache-2.0 许可。宽松许可:允许商业使用、修改和再分发,并附带明确的专利授权;分发时需保留许可与 NOTICE 文件,修改过的文件要注明改动。以上为概括,不构成法律意见,请以许可原文为准。

@discourse/png 的下载量有多少?

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

@discourse/png 还在维护吗?

最新版本 3.1.1 发布于 2026/05/08(6 个月前);至今共发布 1 个版本,其中过去 12 个月发布了 1 个;首次发布于 2026/05/08。发布频率只是参考信号:功能稳定的工具可能很少需要更新,建议结合源码仓库的 issue 和提交记录判断。