# @basenative/config 中文文档

规范地址：https://npmcn.com/package/%40basenative/config/

版本：3\.3\.0
npm 元数据更新时间：2026-11-03T01:38:40.797Z
中文译文更新时间：2026-11-08T03:21:53.504Z
软件包许可：Apache-2\.0

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

原始 npm 页面：https://www.npmjs.com/package/%40basenative/config
原文对照：https://npmcn.com/package/%40basenative/config/?lang=original
项目主页：https://github.com/DuganLabs/BaseNative/tree/main/packages/config#readme
源码仓库：https://github.com/DuganLabs/BaseNative

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

- 包体积（解压后）：15.9 kB，7 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2026-03-20T05:27:47.238Z
- 最新版本发布：2026-11-03T01:38:40.435Z
- 近 30 天下载量：1914（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：14（近 12 个月 14 个）

## 中文简介

类型安全的环境配置装载和验证

## 安装

```sh
npm install @basenative/config
```

也可以使用：`pnpm add @basenative/config`、`yarn add @basenative/config`、`bun add @basenative/config`

## README

# @ aslative/ config

> 具有计划验证的型式安全环境配置

部分 [基础](https://github.com/DuganLabs/basenative) 生态系统——一个基于信号的网络运行时间超过本土的HTML.

## 安装

```bash
npm install @basenative/config
```

## 快速启动

```js
import { defineConfig, string, number, boolean, oneOf } from '@basenative/config';

const config = defineConfig({
  schema: {
    PORT: number(),
    DATABASE_URL: string(),
    NODE_ENV: oneOf(['development', 'production', 'test']),
    DEBUG: boolean(),
  },
});

console.log(config.PORT);         // number
console.log(config.DATABASE_URL); // string
```

## 带有前缀

```js
const config = defineConfig({
  schema: {
    port: number(),
    secret: string(),
  },
  prefix: 'APP_', // reads APP_PORT, APP_SECRET from env
});
```

## 和Zod在一起 和Zod在一起的时候

```js
import { defineConfig, zodAdapter } from '@basenative/config';
import { z } from 'zod';

const config = defineConfig({
  schema: zodAdapter(z.object({
    PORT: z.coerce.number().default(3000),
    DATABASE_URL: z.string().url(),
  })),
});
```

## API 密码

-   `defineConfig(options)` ——从环境变量中装入并验证配置.
    -   `options.schema` - 密钥验证地图或 `zodAdapter` 函数.
    -   `options.env` - env vars 的源对象(默认为 `process.env`) (中文(简体) ).
    -   `options.prefix` ——可选前缀被剥去后再匹配计划键.

### 内建验证器

-   `string()` ——需要非空字符串值.
-   `number()` ——将嵌入字符串为数字;扔出(如果不是数字的话).
-   `boolean()` - 阴道 `'true'`编号 :`'1'` 改为 `true`, (中文(简体) ), `'false'`编号 :`'0'` 改为 `false`。 。 。 .
-   `oneOf(values[])` ——要求将数值作为所列选项之一.
-   `optional(validator)` —— 环绕任何验证符允许缺失/未定义值.
-   `validateConfig(values, schema)` – 以图示验证平面对象; 投出可操作的失败信息 .

### 装入器

-   `loadEnv(path?)` - 装入a `.env` 文件输入 `process.env`默认为 `.env` 在工作目录中.
-   `parseEnvFile(content)` - 说明a `.env` 文件字符串进入普通对象而不发生变异 `process.env`。 。 。 .
-   `zodAdapter(schema)` - 修改 Zod 方案,用于 `defineConfig`。 。 。 .

## 许可证

阿帕奇 - 2.0

## 常见问题

### @basenative/config 是什么？

类型安全的环境配置装载和验证

### 如何安装 @basenative/config？

在项目目录运行 npm install @basenative/config，或使用 pnpm add / yarn add / bun add。

### @basenative/config 支持 TypeScript 吗？

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

### @basenative/config 支持 ESM 还是 CommonJS？

以 ES Module 形式发布，推荐使用 import 引入。在 CommonJS 项目中，Node\.js 20\.19\+ / 22\.12\+ 可以直接 require\(\) 不含顶层 await 的 ES Module，更早的版本需要改用动态 import\(\)。

### @basenative/config 可以商用吗？

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

### @basenative/config 的下载量有多少？

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

### @basenative/config 还在维护吗？

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