# @abinnovision/nestjs-configx 中文文档

规范地址：https://npmcn.com/package/%40abinnovision/nestjs-configx/

版本：2\.1\.1
npm 元数据更新时间：2026-11-08T13:55:50.955Z
中文译文更新时间：2026-11-08T14:35:40.566Z
软件包许可：Apache-2\.0

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

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

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

- 包体积（解压后）：29 kB，20 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：1 个
- 首次发布：2025-02-07T10:56:58.812Z
- 最新版本发布：2026-11-08T13:55:50.578Z
- 近 30 天下载量：1841（2026-10-05 至 2026-11-03，npm 官方下载统计）
- 已发布版本数：18（近 12 个月 15 个）

## 中文简介

基于Schema的环境配置与标准Schema支持NestJS应用程序中的类型安全配置管理.

## 安装

```sh
npm install @abinnovision/nestjs-configx
```

也可以使用：`pnpm add @abinnovision/nestjs-configx`、`yarn add @abinnovision/nestjs-configx`、`bun add @abinnovision/nestjs-configx`

## README

# @abinnovision/nestjs-configx (英语)

[![npm](https://img.shields.io/npm/v/@abinnovision/nestjs-configx?style=flat-square)](https://www.npmjs.com/package/@abinnovision/nestjs-configx)

使用 NestJS 的类型安全配置 [标准Schema](https://standardschema.dev/)。 。 。 .

## 安装

```bash
yarn add @abinnovision/nestjs-configx
```

## 目标

-   类型安全配置从 `process.env`
-   通过标准Schema(Zod, ArkType等)进行Schema-agnostic
-   最小的 NestJS 集成( 仅仅是一个提供者, 没有模块)
-   启动时失败快速验证

## 非目标

-   多个配置来源( 至少还没有)
-   Async 计划验证
-   运行时配置重装
-   保密管理/加密

## 快速启动

### 1\. 定义您的配置

```typescript
import { configx } from "@abinnovision/nestjs-configx";
import { z } from "zod";

export class AppConfigx extends configx(
  z.object({
    PORT: z.string().default("3000").transform(Number),
    HOST: z.string().default("0.0.0.0"),
  }),
) {}
```

### 2\. 登记为提供者

```typescript
import { Module } from "@nestjs/common";
import { AppConfigx } from "./app.configx";

@Module({
  providers: [AppConfigx],
  exports: [AppConfigx],
})
export class AppModule {}
```

### 3\. 注射和使用

```typescript
@Injectable()
export class AppService {
  constructor(private readonly config: AppConfigx) {}

  getPort() {
    return this.config.PORT; // number - fully typed
  }
}
```

## Schema 图书馆

任意 [标准Schema](https://standardschema.dev/#what-schema-libraries-implement-the-spec) 兼容的图书馆工作。 试验过:

-   [佐德语Name](https://github.com/colinhacks/zod)
-   [ArkType 密码](https://github.com/arktypeio/arktype)

### ArkType 实例

```typescript
import { configx } from "@abinnovision/nestjs-configx";
import { type } from "arktype";

export class AppConfigx extends configx(
  type({
    PORT: "string.numeric.parse = '3000'",
    HOST: "string = '0.0.0.0'",
  }),
) {}
```

## 处理错误

无效的配置抛出 `InvalidConfigError` 在即时提示中, 详细了解哪些字段验证失败 .

## 许可证

阿帕奇 - 2.0

## 常见问题

### @abinnovision/nestjs-configx 是什么？

基于Schema的环境配置与标准Schema支持NestJS应用程序中的类型安全配置管理\.

### 如何安装 @abinnovision/nestjs-configx？

在项目目录运行 npm install @abinnovision/nestjs-configx，或使用 pnpm add / yarn add / bun add。

### @abinnovision/nestjs-configx 支持 TypeScript 吗？

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

### @abinnovision/nestjs-configx 支持 ESM 还是 CommonJS？

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

### @abinnovision/nestjs-configx 可以商用吗？

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

### @abinnovision/nestjs-configx 的下载量有多少？

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

### @abinnovision/nestjs-configx 还在维护吗？

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