# @golevelup/profiguration 中文文档

规范地址：https://npmcn.com/package/%40golevelup/profiguration/

版本：0\.2\.1
npm 元数据更新时间：2025-07-18T22:01:51.985Z
中文译文更新时间：2026-11-16T18:45:07.838Z
软件包许可：未声明

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

原始 npm 页面：https://www.npmjs.com/package/%40golevelup/profiguration
原文对照：https://npmcn.com/package/%40golevelup/profiguration/?lang=original

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

- 包体积（解压后）：18.3 kB，13 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：4 个
- peer 依赖：@types/dotenv ^8\.2\.0，@types/convict ^5\.2\.0
- 首次发布：2020-05-18T14:49:22.573Z
- 最新版本发布：2020-05-29T01:12:30.640Z
- 近 30 天下载量：17314（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：8（近 12 个月 0 个）

## 中文简介

## 关于

## 安装

```sh
npm install @golevelup/profiguration
```

也可以使用：`pnpm add @golevelup/profiguration`、`yarn add @golevelup/profiguration`、`bun add @golevelup/profiguration`

## README

# @ golevelup/ 配置

## 关于

探测器目前建在岩石上 [Mozilla的定罪配置库](https://github.com/mozilla/node-convict)它能帮助你 [12 符合](https://12factor.net/config) 应用程序配置,将焦点放在以安全的方式利用环境变量,同时允许您从.env和.json文件中加载配置,以便在开发过程中方便.

## 特征

-   从.env文件或json文件自动装入配置,并带有等级上覆
-   轻松控制哪个配置文件根据您的节点环境加载
-   为支持不同类型认证而建造
-   智能和类型安全
-   简单的测试工具, 当您想要嘲笑您的配置时

## 使用量

### 安装

`npm install ---save @golevelup/profiguration`

或者说

`yarn add @golevelup/profiguration`

### 定义一个代表您预测的界面

界面应代表您想要访问您的应用程序配置的对象结构 。 它可以是一个复杂的物体,有嵌入值和不同类型

例如:

```typescript
interface Config {
  db: {
    password: string;
    host: {
      url: string;
      port: number;
    };
  };
  appPort: number;
  globalPrefix: string;
  controllerPrefix: string;
  showWelcomeMessage: boolean;
}
```

### 创建计算实例

这个 `createProfiguration` 工厂方法需要一种计划,表明您配置接口的各种属性应该如何从进程环境中加载。 见 [定罪证件](https://github.com/mozilla/node-convict/tree/master/packages/convict) 用于补充选项和文件.

第二个参数配置了用于记录、验证和相对文件加载路径的选项以及用户提供的功能 `configureEnv` 允许每个环境压倒配置选项以及应加载包含配置值的文件.

```typescript
import { createProfiguration } from '@golevelup/profiguration';

export const config = createProfiguration<Config>(
  {
    appPort: {
      default: 3333,
      env: 'APP_PORT'
    },
    db: {
      password: {
        default: null,
        format: String,
        env: 'DB_PASSWORD'
      },
      host: {
        url: {
          default: '',
          env: 'DB_HOST_URL'
        },
        port: {
          default: -1,
          format: 'port',
          env: 'DB_HOST_PORT'
        }
      }
    },
    globalPrefix: {
      default: 'api',
      env: 'GLOBAL_PREFIX'
    },
    controllerPrefix: {
      default: '',
      env: 'CONTROLLER_PREFIX'
    },
    showWelcomeMessage: {
      default: true,
      env: 'WELCOME_MESSAGE'
    }
  },
  {
    strict: true,
    verbose: true,
    loadRelativeTo: 'parent-module',
    configureEnv: env => ({
      files: `${env}.env`
    })
  }
);
```

## 常见问题

### @golevelup/profiguration 是什么？

关于

### 如何安装 @golevelup/profiguration？

在项目目录运行 npm install @golevelup/profiguration，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：@types/dotenv（^8\.2\.0）、@types/convict（^5\.2\.0）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @golevelup/profiguration 支持 TypeScript 吗？

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

### @golevelup/profiguration 支持 ESM 还是 CommonJS？

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

### @golevelup/profiguration 可以商用吗？

@golevelup/profiguration 使用 未声明 许可。package\.json 没有声明许可证。没有许可证的代码默认保留全部权利，商用前请联系作者或查看仓库中的 LICENSE 文件。以上为概括，不构成法律意见，请以许可原文为准。

### @golevelup/profiguration 的下载量有多少？

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

### @golevelup/profiguration 还在维护吗？

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

