# @ayroblu/playwright-image-snapshot 中文文档

规范地址：https://npmcn.com/package/%40ayroblu/playwright-image-snapshot/

版本：0\.3\.9
npm 元数据更新时间：2022-11-20T15:23:39.752Z
中文译文更新时间：2026-11-07T14:47:17.948Z
软件包许可：Apache-2\.0

本文由上游 README 翻译，可能存在偏差，请结合原文核对 API、命令与配置。版权与许可归原作者所有。

原始 npm 页面：https://www.npmjs.com/package/%40ayroblu/playwright-image-snapshot
原文对照：https://npmcn.com/package/%40ayroblu/playwright-image-snapshot/?lang=original
项目主页：https://github.com/ayroblu/playwright-image-snapshot#readme
源码仓库：https://github.com/ayroblu/playwright-image-snapshot

## 关键信息（来自 npm 元数据）

- 包体积（解压后）：37.6 kB，27 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=12\.0\.0
- 运行依赖：7 个
- peer 依赖：@playwright/test ^1\.\*
- 首次发布：2022-02-17T19:01:04.850Z
- 最新版本发布：2022-11-20T15:23:39.591Z
- 近 30 天下载量：15058（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：10（近 12 个月 0 个）

## 中文简介

增强 @ playwright/ test 的截图比较

## 安装

```sh
npm install @ayroblu/playwright-image-snapshot
```

也可以使用：`pnpm add @ayroblu/playwright-image-snapshot`、`yarn add @ayroblu/playwright-image-snapshot`、`bun add @ayroblu/playwright-image-snapshot`

## README

# 剧作家-影像-相片

为 @ playwright/ test 增强图像快照 。 经修改的叉 [剧作家-影像-相片](https://github.com/florianbepunkt/playwright-image-snapshot) 来源于 `jest-image-snapshot` (单位:千美元)[https://github.com/american spression/jest-image-snapshot 页面存档备份,存于互联网档案馆](https://github.com/americanexpress/jest-image-snapshot)) 为Playwright.

## 安装

`npm install --save-dev @ayroblu/playwright-image-snapshot`

## 使用量

```ts
// add a global.d.ts to your src directory (if you use TypeScript)
import type {
  ImageSnapshotOptions,
  TestInfo,
} from "@ayroblu/playwright-image-snapshot";

declare global {
  namespace PlaywrightTest {
    interface Matchers<R> {
      toMatchImageSnapshot(
        testInfo: TestInfo,
        name: string[] | string,
        options?: ImageSnapshotOptions,
      ): R;
    }
  }
}

// playwright.config.ts file
import { toMatchImageSnapshot } from "playwright-image-snapshot";
expect.extend({ toMatchImageSnapshot });

// or if you want to configure it
import { configureToMatchImageSnapshot } from "playwright-image-snapshot";
const toMatchImageSnapshot = configureToMatchImageSnapshot({
  failureThreshold: process.env["CI"] ? 0.05 : 0.01,
});
expect.extend({ toMatchImageSnapshot });

// In your test.spec.ts
expect(await page.screenshot()).toMatchImageSnapshot(test.info(), ["folder-name", "name-to-identify-snapshot.png"]);

// alternatively for more control
// expect(await page.screenshot()).toMatchImageSnapshot(test.info(), "name-to-identify-snapshot.png", {
//   blur: 2,
//   comparisonMethod: "ssim",
//   failureThreshold: 0.02,
//   failureThresholdType: "percent",
// });
```

## 常见问题

### @ayroblu/playwright-image-snapshot 是什么？

增强 @ playwright/ test 的截图比较

### 如何安装 @ayroblu/playwright-image-snapshot？

在项目目录运行 npm install @ayroblu/playwright-image-snapshot，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@playwright/test（^1\.\*）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @ayroblu/playwright-image-snapshot 支持 TypeScript 吗？

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

### @ayroblu/playwright-image-snapshot 支持 ESM 还是 CommonJS？

以 CommonJS 形式发布，可以直接 require\(\)；在 ES Module 项目中也可以用 import 引入（Node\.js 会把 module\.exports 作为默认导出）。

### @ayroblu/playwright-image-snapshot 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=12\.0\.0。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @ayroblu/playwright-image-snapshot 可以商用吗？

@ayroblu/playwright-image-snapshot 使用 Apache-2\.0 许可。宽松许可：允许商业使用、修改和再分发，并附带明确的专利授权；分发时需保留许可与 NOTICE 文件，修改过的文件要注明改动。以上为概括，不构成法律意见，请以许可原文为准。

### @ayroblu/playwright-image-snapshot 的下载量有多少？

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

### @ayroblu/playwright-image-snapshot 还在维护吗？

最新版本 0\.3\.9 发布于 2022/11/20（3 年前）；至今共发布 10 个版本，其中过去 12 个月发布了 0 个；首次发布于 2022/02/18。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。