# @gradecam/tsenum 中文文档

规范地址：https://npmcn.com/package/%40gradecam/tsenum/

版本：1\.2\.0
npm 元数据更新时间：2025-10-28T16:58:27.081Z
中文译文更新时间：2026-11-16T21:31:17.627Z
软件包许可：ISC

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

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

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

- 包体积（解压后）：9.7 kB，4 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- 运行依赖：0 个
- 首次发布：2019-08-14T20:04:19.222Z
- 最新版本发布：2019-08-21T00:40:02.746Z
- 近 30 天下载量：11457（2026-10-17 至 2026-11-15，npm 官方下载统计）
- 已发布版本数：3（近 12 个月 0 个）

## 中文简介

用于字符串相容 enums 的超简单的打字程序库

## 安装

```sh
npm install @gradecam/tsenum
```

也可以使用：`pnpm add @gradecam/tsenum`、`yarn add @gradecam/tsenum`、`bun add @gradecam/tsenum`

## README

# 说明

现在 Typescription 支持 enum, 但有时你可能需要比 内建的 enums 给您; 此软件包是从一个从打字符链接的格子中的例子修改出来的 我现在找不到的问题,但只要说,尽管我们稍作修改 对我们来说不是独创的.

# 安装

```
npm install --save @gradecam/tsenum
```

# 基本用途

```
import {MakeEnum, TypeFromEnum} from 'tsenum';

const Colors = MakeEnum({
    Red: 'red',
    Blue: 'blue',
    Green: 'green',
    Violet: 'violet',
    Black: 'black'
});
type Colors = TypeFromEnum<typeof Colors>;

// type Colors = 'red' | 'blue' | 'green' | 'violet' | 'black'
// value Colors is a frozen object with the keys expected
// typeof Colors.Red is 'red', et al

carColor: Colors = 'red'; // valid
carColor = Colors.Green; // valid
carColor = 'yellow'; // typescript error, not a valid color
```

# 组合类型

MakeEnum将多个enum对象合并为一个(最多为9个),允许您合并类型.

```
import {MakeEnum, TypeFromEnum} from 'tsenum';

const PrimaryColors = MakeEnum({
    Red: 'red',
    Blue: 'blue',
    Green: 'green',
});
type PrimaryColors = TypeFromEnum<typeof PrimaryColors>;

const SecondaryColors = MakeEnum({
    Yellow: 'yellow',
    Cyan: 'cyan',
    Magenta: 'magenta'
});
type SecondaryColors = TypeFromEnum<typeof SecondaryColors>;

const AllColors = MakeEnum(PrimaryColors, SecondaryColors);
type AllColors = TypeFromEnum<typeof AllColors>;
// type AllColors = 'red' | 'blue' | 'green' | 'yellow' | 'cyan' | 'magenta'
```

# 获取一系列可能的值

有时您可能想要一系列可能的值, 例如在 mongoose 中定义 enum 类型时 计划 由于enum是一个对象,你可以使用 `Object.values` 获取:

```
import {MakeEnum, TypeFromEnum} from 'tsenum';

const PrimaryColors = MakeEnum({
    Red: 'red',
    Blue: 'blue',
    Green: 'green',
});
type PrimaryColors = TypeFromEnum<typeof PrimaryColors>;

const PrimaryColorList = Object.values(PrimaryColors); // ['red', 'blue', 'green']
// typeof PrimaryColorList = Array<'red'|'blue'|'green'>
```

# 允许的值类型

当前您可以使用任意字符串、 数字或布尔作为值

## 常见问题

### @gradecam/tsenum 是什么？

用于字符串相容 enums 的超简单的打字程序库

### 如何安装 @gradecam/tsenum？

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

### @gradecam/tsenum 支持 TypeScript 吗？

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

### @gradecam/tsenum 支持 ESM 还是 CommonJS？

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

### @gradecam/tsenum 可以商用吗？

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

### @gradecam/tsenum 的下载量有多少？

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

### @gradecam/tsenum 还在维护吗？

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

