# @beesley/ts-env 中文文档

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

版本：1\.0\.1
npm 元数据更新时间：2023-10-06T13:59:53.496Z
中文译文更新时间：2026-11-07T20:36:23.825Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：42.2 kB，87 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=18\.12
- 运行依赖：0 个
- 首次发布：2023-10-06T13:49:40.362Z
- 最新版本发布：2023-10-06T13:59:53.299Z
- 近 30 天下载量：17758（2026-10-08 至 2026-11-06，npm 官方下载统计）
- 已发布版本数：2（近 12 个月 0 个）

## 中文简介

TypeScript 的环境变量读取器

## 安装

```sh
npm install @beesley/ts-env
```

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

## README

# @beesley/ts-env (英语) [出口](https://npmcn.com/package/%40beesley/ts-env/docs/modules.md)

[![Build, Test & Publish Main](https://github.com/bbeesley/ts-env/actions/workflows/build-test-on-push.yml/badge.svg)](https://github.com/bbeesley/ts-env/actions/workflows/build-test-on-push.yml) [![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/) [![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)

TypeScript 的环境可变读取器. 简单而最小

这基本上是由 @lpgera 创建的软件包, 但是由于软件包在使用 es 模块时, 与打字机完全不兼容, 我把它加固并重建, 是一个通用的软件包, 可以使用 es 模块或普通的 js .

## 安装

此软件包需要 `typescript` 将安装.

```bash
# with npm
npm install @beesley/ts-env

# or with Yarn
yarn add @beesley/ts-env
```

## 示例

不读取不同类型的环境变量 `ts-env`数字 :

```typescript
if (!process.env.PORT) {
  throw new Error('process.env.PORT is missing')
}
if (!process.env.DATABASE) {
  throw new Error('process.env.DATABASE is missing')
}

const port: number = parseInt(process.env.PORT)
const database: string = process.env.DATABASE
const debug: boolean | undefined = process.env.DEBUG === 'true'
```

做同样的事情 `ts-env`数字 :

```typescript
import tsEnv from '@beesley/ts-env'

const port: number = tsEnv.numberOrThrow('PORT')
const database: string = tsEnv.stringOrThrow('DATABASE')
const debug: boolean | undefined = tsEnv.boolean('DEBUG')
```

## API 密码

### .string(键:字符串):字符串qq未定义

从 `process.env[key]`。 。 。 .

### .stringOrthrow(键:字符串):字符串

从 `process.env[key]`。 。 。 . 如果发生错误, 则丢出错误 `undefined`。 。 。 .

### .boolean(键:字符串):布尔qq未定义

读取布尔值 `process.env[key]`。 。 。 . "0"和"假"被认为是 `false`,"1"和"真实"被认为是 `true`。 。 。 . 其他一切将读为 `undefined`。 。 。 .

### .boolean Orthrow( 键: 字符串):布尔

读取布尔值 `process.env[key]`。 。 。 . "0"和"假"被认为是 `false`,"1"和"真实"被认为是 `true`。 。 。 . 其他的都会造成一个错误.

### 数字( 键: 字符串): 未定义的数字 qq

从 `process.env[key]`。 。 。 . 如果一个数字无法解析, 将会返回 `undefined`。 。 。 .

### 数字 Orthrow( 键: 字符串): 数字

从 `process.env[key]`。 。 。 . 如果一个数字无法解析, 则会出现出错 .

### .stringArray(键:字符串,分隔符:字符串=','):字符串\[\]QQ未定义

从 `process.env[key]`。 。 。 .

### .stringArray Orthrow(键:字符串,分隔符:字符串=','):字符串\[\]

从 `process.env[key]`。 。 。 . 如果发生错误, 则丢出错误 `undefined`。 。 。 .

### . 数字Array(键:字符串,分隔符:字符串=','):数字\[\] QQ 未定义

读取数字数组 `process.env[key]`。 。 。 . 如果无法解析任何项目, 将返回 `undefined`。 。 。 .

### 数字Array Orthrow(键:字符串,分隔符:字符串=','):数字\[\]

读取数字数组 `process.env[key]`。 。 。 . 如果无法解析任何项目, 就会出现错误 .

## 常见问题

### @beesley/ts-env 是什么？

TypeScript 的环境变量读取器

### 如何安装 @beesley/ts-env？

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

### @beesley/ts-env 支持 TypeScript 吗？

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

### @beesley/ts-env 支持 ESM 还是 CommonJS？

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

### @beesley/ts-env 需要什么版本的 Node\.js？

package\.json 的 engines 字段要求 Node\.js \>=18\.12。版本不符时 npm 默认只给出警告，开启 engine-strict 后会拒绝安装。

### @beesley/ts-env 可以商用吗？

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

### @beesley/ts-env 的下载量有多少？

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

### @beesley/ts-env 还在维护吗？

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