@blazediff/codec-pngjs

中文文档
4.0.0发布于 2026/03/20MITTypeScriptESM + CJS近 30 天下载 1.5万

PNG image codec using pngjs for the blazediff library

原始使用文档
文档目录5 节
  1. Installation
  2. API
  3. read(filePath)
  4. write(image, filePath)
  5. Usage

@blazediff/codec-pngjs

npm bundle size NPM Downloads

PNG image codec using pngjs for the BlazeDiff library.

Note: This package was previously published as @blazediff/pngjs-transformer, which is now deprecated. Please use @blazediff/codec-pngjs instead.

Installation

npm install @blazediff/codec-pngjs

API

read(filePath)

Reads a PNG file to image format (Uint8Array).

Parameters:

  • filePath (string) - Path to the PNG file

Returns: Promise<{ data: Buffer | Uint8Array | Uint8ClampedArray; width: number; height: number; }>

write(image, filePath)

Write a BlazeDiff image to a PNG file.

Parameters:

  • image ({ data: Buffer | Uint8Array | Uint8ClampedArray; width: number; height: number; }) - Image data to write
  • filePath (string) - Output file path

Returns: Promise

Usage

import { codecPngjs } from '@blazediff/codec-pngjs';

const image = await codecPngjs.read('./image.png');

await codecPngjs.write(image, './output.png');

版本与发布记录

@blazediff/codec-pngjs 共发布 2 个版本,首次发布于 2026/03/12;过去 12 个月发布了 2 个版本。

版本发布日期距今
4.0.0latest2026/03/207 个月前
3.0.02026/03/127 个月前

关于 @blazediff/codec-pngjs 的常见问题

@blazediff/codec-pngjs 是什么?

PNG image codec using pngjs for the blazediff library

如何安装 @blazediff/codec-pngjs?

在项目目录运行 npm install @blazediff/codec-pngjs,或使用 pnpm add / yarn add / bun add。

@blazediff/codec-pngjs 支持 TypeScript 吗?

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

@blazediff/codec-pngjs 支持 ESM 还是 CommonJS?

同时提供 ES Module 与 CommonJS 入口,import 和 require() 都可以使用,打包工具会自动选择合适的版本。

@blazediff/codec-pngjs 可以商用吗?

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

@blazediff/codec-pngjs 的下载量有多少?

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

@blazediff/codec-pngjs 还在维护吗?

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