# @dcl/ui-env 中文文档

规范地址：https://npmcn.com/package/%40dcl/ui-env/

版本：2\.1\.0
npm 元数据更新时间：2026-09-14T13:01:09.018Z
中文译文更新时间：2026-11-11T18:00:24.283Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：17.4 kB，19 个文件
- 模块格式：ES Module
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2022-06-02T19:46:55.948Z
- 最新版本发布：2026-09-14T13:01:08.572Z
- 近 30 天下载量：6513（2026-10-12 至 2026-11-10，npm 官方下载统计）
- 已发布版本数：29（近 12 个月 5 个）

## 中文简介

此软件包可用于生成不同环境的配置,用于一般的网络应用和前端. 这对具有被部署到不同管子(如推出)的单一构件的前端来说是有用的.

## 安装

```sh
npm install @dcl/ui-env
```

也可以使用：`pnpm add @dcl/ui-env`、`yarn add @dcl/ui-env`、`bun add @dcl/ui-env`

## README

# 欧文

此软件包可用于生成不同环境的配置,用于一般的网络应用和前端. 这对具有被部署到不同管子(如推出)的单一构件的前端来说是有用的.

## 安装

```bash
npm i @dcl/ui-env
```

## 使用量

你需要创建一个 `config` 实例来传递所有想要的嵌入物的不同变量.

```js
// config/env/dev|stg|prod.json
{
  "FOO": "bar"
}
```

```ts
// config/index.ts
import { Env, createConfig } from '@dcl/ui-env'
import dev from './env/dev.json'
import stg from './env/stg.json'
import prod from './env/prod.json'

export const config = createConfig({
  [Env.DEVELOPMENT]: dev,
  [Env.STAGING]: stg,
  [Env.PRODUCTION]: prod,
})
```

然后从代码基础的其他部分获得变量值

```ts
// some-file.ts
import { config } from './config'

const someVar = config.get('FOO') // "bar"
```

您可以通过默认值作为第二个参数

```ts
const someVar = config.get('NON_EXISTENT_VAR', 'defaultValue') // "defaultValue"
```

配置将会通过检查顶级域从正确的环境中取出值 :

-   `Env.DEVELOPMENT`: 如果 TLD 是 `.io` 或者说 `.zone`
-   `Env.STAGING`: 如果 TLD 是 `.net` 或者说 `.today`
-   `Env.PRODUCTION`: 如果 TLD 是 `.org`

您可以通过一个查询参数来覆盖此逻辑 `env` 带值 `dev`, (中文(简体) ), `stg` 或者说 `prod`。参数名称及其值可以是大写或小写.

例如:

-   `https://builder.decentraland.io?env=prod`: 这将使用 `Env.PRODUCTION`
-   `http://localhost:3000?env=dev`: 这将使用 `Env.DEVELOPMENT`

如果找不到 TLD 且没有查询参数, 将使用默认环境, 即 `Env.PRODUCTION`。 。 。 .

如果您想要覆盖默认环境, 您可以使用环境 var `DCL_DEFAULT_ENV`, (中文(简体) ), `REACT_APP_DCL_DEFAULT_ENV` 或者说 `VITE_DCL_DEFAULT_ENV` 并设定值 `dev`, (中文(简体) ), `stg` 或者说 `prod`。 。 。 .

这对于配置当地环境或部署到Vercel's等其他非分散域可能有用.

例如:

```bash
# .env
REACT_APP_DCL_DEFAULT_ENV=dev
```

现在 `http://localhost:3000` 使用该 `Env.DEVELOPMENT` 配置无需通过查询参数.

## 测试

```bash
npm test
```

或有报道

```bash
npm run test:coverage
```

## 构建

```bash
npm run build
```

## 释放

要发布此软件包的新版本 [新发行](https://github.com/decentraland/ui-env/releases) 通过 GitHub

## 常见问题

### @dcl/ui-env 是什么？

此软件包可用于生成不同环境的配置,用于一般的网络应用和前端\. 这对具有被部署到不同管子\(如推出\)的单一构件的前端来说是有用的\.

### 如何安装 @dcl/ui-env？

在项目目录运行 npm install @dcl/ui-env，或使用 pnpm add / yarn add / bun add。

### @dcl/ui-env 支持 TypeScript 吗？

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

### @dcl/ui-env 支持 ESM 还是 CommonJS？

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

### @dcl/ui-env 可以商用吗？

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

### @dcl/ui-env 的下载量有多少？

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

### @dcl/ui-env 还在维护吗？

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