@discourse/jpeg

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

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

中文使用文档
文档目录6 节
  1. 安装
  2. 使用量
  3. 解码( 数据: ArrayBuffer, 选项? : 解码选项): 承诺
  4. 编码( 数据: 图像数据, 选项? : 编码选项): 承诺
  5. 手工 WASM 初始化( 不推荐)
  6. 已知问题

翻译:

npm version

在浏览器中对JPEG图像进行编码和解码的简单体验. 由WebAssembly提供电力.

使用 莫兹杰普格 图书馆.

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

安装

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

使用量

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

解码( 数据: ArrayBuffer, 选项? : 解码选项): 承诺

解码 JPEG 二进制矩阵缓冲器到原始的 RGB 图像数据 .

数据

类型 : ArrayBuffer

选项

类型 : Partial<DecodeOptions>

解码器的自定义选项 。 设置 preserveOrientation 改为 true 将在元数据标签的基础上将图像旋转到正确的方向。 默认设置为 false。 。 。 .

示例

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

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

编码( 数据: 图像数据, 选项? : 编码选项): 承诺

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

数据

类型 : ImageData

选项

类型 : Partial<EncodeOptions>

MozJPEG 输出图像的编码器选项. 参见默认值。 。 。 .

示例

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

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.png');
const jpegBuffer = await encode(rawImageData);

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

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

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

import decode, { init as initJpegDecode } from '@jsquash/jpeg/decode';

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

您也可以通过自定义选项到 init 函数可以自定义模块的行为。 见 标记文件 更多信息.

import decode, { init as initJpegDecode } from '@jsquash/jpeg/decode';

initJpegDecode(null, {
  // Customise the path to load the wasm file
  locateFile: (path, prefix) => `https://example.com/${prefix}/${path}`,
});
const image = await fetch('./image.jpeg').then(res => res.arrayBuffer()).then(decode);

已知问题

见 jSquash 项目编辑器

版本与发布记录

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

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

关于 @discourse/jpeg 的常见问题

@discourse/jpeg 是什么?

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

如何安装 @discourse/jpeg?

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

@discourse/jpeg 支持 TypeScript 吗?

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

@discourse/jpeg 支持 ESM 还是 CommonJS?

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

@discourse/jpeg 可以商用吗?

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

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

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

@discourse/jpeg 还在维护吗?

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