# @clipboard-health/testing-core 中文文档

规范地址：https://npmcn.com/package/%40clipboard-health/testing-core/

版本：2\.13\.15
npm 元数据更新时间：2026-11-05T04:55:58.228Z
中文译文更新时间：2026-11-10T01:53:35.133Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40clipboard-health/testing-core
原文对照：https://npmcn.com/package/%40clipboard-health/testing-core/?lang=original
项目主页：https://github.com/ClipboardHealth/core-utils#readme
源码仓库：https://github.com/ClipboardHealth/core-utils

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

- 包体积（解压后）：21.5 kB，35 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：zod ^3
- 首次发布：2024-10-22T19:15:04.838Z
- 最新版本发布：2026-11-05T04:55:58.039Z
- 近 30 天下载量：21913（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：480（近 12 个月 385 个）

## 中文简介

TypeScript 方便测试工具.

## 安装

```sh
npm install @clipboard-health/testing-core
```

也可以使用：`pnpm add @clipboard-health/testing-core`、`yarn add @clipboard-health/testing-core`、`bun add @clipboard-health/testing-core`

## README

# @ clippboard-health/testing-core (英语)

TypeScript 方便测试工具.

## 目录

-   [安装](https://npmcn.com/package/%40clipboard-health/testing-core/#readme-install)
-   [使用量](https://npmcn.com/package/%40clipboard-health/testing-core/#readme-usage)
    -   [合同固定装置](https://npmcn.com/package/%40clipboard-health/testing-core/#readme-contract-fixtures)
    -   [类型缩小 `expect` 帮助者](https://npmcn.com/package/%40clipboard-health/testing-core/#readme-type-narrowing-expect-helpers)
-   [地方发展指挥部](https://npmcn.com/package/%40clipboard-health/testing-core/#readme-local-development-commands)

## 安装

```bash
npm install @clipboard-health/testing-core
```

## 使用量

### 合同固定装置

分析API反应装置,通过他们拥有的Zod公司合同,因此在 固定装置已经构建。 使用 `buildContractFixture` 一次性固定装置:

```ts
import { FeatureResponseSchema } from "@clipboard-health/contract-feature";
import { buildContractFixture } from "@clipboard-health/testing-core";

export const mockFeature = buildContractFixture({
  schema: FeatureResponseSchema,
  fixture: { id: "feature-id" },
});
```

使用 `createContractFixtureBuilder` 具有浅重功能的固定家庭:

```ts
import { createContractFixtureBuilder } from "@clipboard-health/testing-core";

const buildFeature = createContractFixtureBuilder({
  schema: FeatureResponseSchema,
  defaults: { id: "default-id", name: "Default" },
});

export const mockRenamedFeature = buildFeature({ name: "Renamed" });
```

两个帮助者都接受schema输入并返回schema输出,包括Zod变换.

### 类型缩小 `expect` 帮助者

贾斯特的 [`expect(...).toBeDefined()`](https://jestjs.io/docs/expect#tobedefined) 不缩小类型.

这给出了类型错误 :

```ts
const value = getValue(); // returns 'string | undefined'

expect(value).toBeDefined();

const { length } = value;
// ^? Property 'length' does not exist on type 'string | undefined'.
```

这个库的助手狭义类型 :

```ts
import { strictEqual } from "node:assert/strict";

import { expectToBeDefined } from "@clipboard-health/testing-core";

function getValue(): string | undefined {
  return "hi";
}

const value = getValue();
expectToBeDefined(value);

// Narrowed to `string`
const { length } = value;
strictEqual(length, 2);
```

```ts
import { strictEqual } from "node:assert/strict";

import { expectToBeLeft } from "@clipboard-health/testing-core";
import { either as E } from "@clipboard-health/util-ts";

function divide(numerator: number, denominator: number): E.Either<string, number> {
  if (denominator === 0) {
    return E.left("Cannot divide by zero");
  }

  return E.right(numerator / denominator);
}

const value = divide(10, 0);
expectToBeLeft(value);

// Narrowed to Left
strictEqual(value.left, "Cannot divide by zero");
```

```ts
import { strictEqual } from "node:assert/strict";

import { expectToBeRight } from "@clipboard-health/testing-core";
import { either as E } from "@clipboard-health/util-ts";

function divide(numerator: number, denominator: number): E.Either<string, number> {
  if (denominator === 0) {
    return E.left("Cannot divide by zero");
  }

  return E.right(numerator / denominator);
}

const value = divide(10, 2);
expectToBeRight(value);

// Narrowed to Right
strictEqual(value.right, 5);
```

```ts
import { strictEqual } from "node:assert/strict";

import { expectToBeFailure } from "@clipboard-health/testing-core";
import { failure, type ServiceResult, success } from "@clipboard-health/util-ts";

function validateAge(age: number): ServiceResult<number> {
  if (age < 0) {
    return failure({ issues: [{ code: "INVALID_AGE", message: "Age cannot be negative" }] });
  }

  return success(age);
}

const result = validateAge(-5);
expectToBeFailure(result);

// Narrowed to Left (Failure)
strictEqual(result.left.issues[0]?.message, "Age cannot be negative");
```

```ts
import { strictEqual } from "node:assert/strict";

import { expectToBeSuccess } from "@clipboard-health/testing-core";
import { failure, type ServiceResult, success } from "@clipboard-health/util-ts";

function validateAge(age: number): ServiceResult<number> {
  if (age < 0) {
    return failure({ issues: [{ code: "INVALID_AGE", message: "Age cannot be negative" }] });
  }

  return success(age);
}

const result = validateAge(25);
expectToBeSuccess(result);

// Narrowed to Right (Success)
strictEqual(result.right, 25);
```

```ts
import { strictEqual } from "node:assert/strict";

import { expectToBeDefined, expectToBeSafeParseError } from "@clipboard-health/testing-core";
import { z } from "zod";

const schema = z.object({ name: z.string() });

const value = schema.safeParse({ name: 1 });
expectToBeSafeParseError(value);

// Narrowed to `SafeParseError`
const [firstIssue] = value.error.issues;
expectToBeDefined(firstIssue);

// Narrowed to `ZodIssue`
strictEqual(firstIssue.message, "Expected string, received number");
```

```ts
import { strictEqual } from "node:assert/strict";

import { expectToBeSafeParseSuccess } from "@clipboard-health/testing-core";
import { z } from "zod";

const schema = z.object({ name: z.string() });

const value = schema.safeParse({ name: "hi" });
expectToBeSafeParseSuccess(value);

// Narrowed to `SafeParseSuccess`
strictEqual(value.data.name, "hi");
```

## 地方发展指挥部

见 [`package.json`](https://npmcn.com/package/%40clipboard-health/testing-core/package.json) `scripts` 用于命令列表.

## 常见问题

### @clipboard-health/testing-core 是什么？

TypeScript 方便测试工具\.

### 如何安装 @clipboard-health/testing-core？

在项目目录运行 npm install @clipboard-health/testing-core，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：zod（^3）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @clipboard-health/testing-core 支持 TypeScript 吗？

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

### @clipboard-health/testing-core 支持 ESM 还是 CommonJS？

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

### @clipboard-health/testing-core 可以商用吗？

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

### @clipboard-health/testing-core 的下载量有多少？

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

### @clipboard-health/testing-core 还在维护吗？

最新版本 2\.13\.15 发布于 2026/11/05（4 天前）；至今共发布 480 个版本，其中过去 12 个月发布了 385 个；首次发布于 2024/10/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。