# @clipboard-health/config 中文文档

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

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

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

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

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

- 包体积（解压后）：20.9 kB，14 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：zod ^3
- 首次发布：2024-10-28T19:27:24.144Z
- 最新版本发布：2026-11-05T04:57:16.859Z
- 近 30 天下载量：11600（2026-10-10 至 2026-11-08，npm 官方下载统计）
- 已发布版本数：495（近 12 个月 392 个）

## 中文简介

类型安全静态配置管理:一个纯能解决,对照Zod schema验证,并冻结配置值的功能.

## 安装

```sh
npm install @clipboard-health/config
```

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

## README

# @ clippboard- 健康/ 配置

类型安全静态配置管理:一个纯函数,用于解析,对照Zod进行验证 计划,并冻结配置值.

配置值按从最高优先级到最低优先级排列:

1.  环境变量
    -   已解析将配置路径从骆驼Case转换为 UPPER SNAKE 。 例如 `{ myApi: { port: 3000 } }` 配置解析为 `MY_API_PORT`。 。 。 .
2.  环境特定覆盖, QQlink ConfigValue. overrides}
3.  默认值, QQlink 配置。 默认值

支持的配置值类型 :

-   二进制
-   布尔
-   日期
-   编号
-   字符串
-   使用以上类型的数组和嵌入对象

要覆盖带有环境变量的数组,请使用字符串化的JSON数组,例如. `["a","b"]`。 。 。 .

**重要性**: 为了避免运行时间出错:

1.  环境变量是字符串,所以使用 `z.coerce` 你计划要征服的人的Zod类型. 请注意: `z.coerce.boolean()` 强迫任何真实值 `true`限制 `"true" | "false"`,使用 `booleanString` 计划从 `@clipboard-health/contract-core`。 。 。 .
2.  生成的配置被深深冻结, 如果您尝试, 将会丢出运行时间错误 修改它。 实际返回类型是 `ReadonlyDeep<SchemaT>`,但库返回 `Readonly<SchemaT>` 因为前者防止客户端将配置值传递到 不明确接受的函数 `readonly` 类型.

## 目录

-   [安装](https://npmcn.com/package/%40clipboard-health/config/#readme-install)
-   [使用量](https://npmcn.com/package/%40clipboard-health/config/#readme-usage)
    -   [类型安全配置](https://npmcn.com/package/%40clipboard-health/config/#readme-type-safe-configuration)
-   [地方发展指挥部](https://npmcn.com/package/%40clipboard-health/config/#readme-local-development-commands)

## 安装

```bash
npm install @clipboard-health/config
```

## 使用量

### 类型安全配置

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

import { createConfig } from "@clipboard-health/config";
import { z } from "zod";

const allowed = ["local", "development", "production"] as const;
type Allowed = (typeof allowed)[number];

function createEnvironmentConfig(current: Allowed) {
  return createConfig({
    config: {
      baseUrl: {
        defaultValue: "http://localhost:3000",
        description: "Base URL for API requests",
        overrides: {
          development: "https://dev.example.com",
          production: "https://api.example.com",
        },
      },
      database: {
        port: {
          defaultValue: 5432,
          description: "Database port",
        },
      },
    },
    environment: { allowed, current },
    schema: z.object({
      baseUrl: z.string().url(),
      database: z.object({
        // Use `z.coerce` to override with environment variables.
        port: z.coerce.number().min(1024).max(65_535),
      }),
    }),
  });
}

{
  // Uses default values.
  const config = createEnvironmentConfig("local");
  ok(config.baseUrl === "http://localhost:3000");
  ok(config.database.port === 5432);
}

{
  // Uses baseUrl environment override.
  const config = createEnvironmentConfig("development");
  ok(config.baseUrl === "https://dev.example.com");
  ok(config.database.port === 5432);
}

// Uses environment variable overrides.
const original = { ...process.env };
try {
  process.env["BASE_URL"] = "https://staging.example.com";
  process.env["DATABASE_PORT"] = "54320";

  const config = createEnvironmentConfig("local");
  ok(config.baseUrl === "https://staging.example.com");
  ok(config.database.port === 54_320);
} finally {
  process.env = { ...original };
}
```

## 地方发展指挥部

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

## 常见问题

### @clipboard-health/config 是什么？

类型安全静态配置管理:一个纯能解决,对照Zod schema验证,并冻结配置值的功能\.

### 如何安装 @clipboard-health/config？

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

### @clipboard-health/config 支持 TypeScript 吗？

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

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

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

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

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

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

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

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

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