@discourse/oxipng

中文文档
2.3.0发布于 2026/05/08Apache-2.0TypeScriptES Module近 30 天下载 1万

Wasm png optimiser 支持浏览器 。 从Squoosh App重新包装.

中文使用文档
文档目录5 节
  1. 安装
  2. 使用量
  3. 优化( 数据: ArrayBuffer, 选项? : 优化选项): 承诺
  4. 激活多线索
  5. 手工 WASM 初始化( 不推荐)

翻译:

npm version

在浏览器中优化PNG图像的简单体验. 由Web Assembly QQ和Rust提供动力.

用可爱的 奥克西平 用于 png 优化.

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

安装

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

使用量

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

优化( 数据: ArrayBuffer, 选项? : 优化选项): 承诺

优化 PNG 图像缓冲器或原始图像数据,并解析优化的 PNG 图像缓冲器输出

数据

类型 : ArrayBuffer | ImageData

选项

类型 : Partial<OptimiseOptions>

Oxipng 优化输出图像选项 . 参见默认值。 。 。 .

  • interlace (boolean) 是否使用 PNG 插座 。 相接会增加优化图像的大小.
  • level (数字)是1到6之间的优化水平. 关卡越高,压缩越多. 任何4级以上都不推荐.
  • optimiseAlpha (boolean)是否允许修改透明的像素来改进压缩.

示例

import { optimise } from '@jsquash/oxipng';

const formEl = document.querySelector('form');
const formData = new FormData(formEl);
// Assuming user selected an input png file
const pngImageBuffer = await formData.get('image').arrayBuffer();

const optimisedPngBuffer = await optimise(pngImageBuffer, { level: 3 });

激活多线索

默认情况下,优化函数将使用一线程来优化图像. 如果您想要加快速度, 您可以启用以下的多条读取 .

  1. 移动您的电话 optimise 改为 a 网络工人。 。 。 .
  2. 配置您的网络服务器以使用以下信头( 这是 a 安保要求(中文(简体) )
    • Cross-Origin-Opener-Policy: same-origin
    • Cross-Origin-Embedder-Policy: require-corp

这仍然只在支持多行读的浏览器中生效. 如果浏览器不支持它,它会倒回单线程模式

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

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

这个 optimise 模块导出 a init 函数,用于手动加载原模块.

import optimise, { init } from '@jsquash/oxipng/optimise';

init(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(optimise);

版本与发布记录

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

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

关于 @discourse/oxipng 的常见问题

@discourse/oxipng 是什么?

Wasm png optimiser 支持浏览器 。 从Squoosh App重新包装.

如何安装 @discourse/oxipng?

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

@discourse/oxipng 支持 TypeScript 吗?

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

@discourse/oxipng 支持 ESM 还是 CommonJS?

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

@discourse/oxipng 可以商用吗?

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

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

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

@discourse/oxipng 还在维护吗?

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