# @buka/class-transformer-extra 中文文档

规范地址：https://npmcn.com/package/%40buka/class-transformer-extra/

版本：2\.1\.4
npm 元数据更新时间：2024-12-18T17:53:51.509Z
中文译文更新时间：2026-11-08T19:25:32.752Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40buka/class-transformer-extra
原文对照：https://npmcn.com/package/%40buka/class-transformer-extra/?lang=original
项目主页：https://github.com/buka-lnc/npm.class-transformer-extra/#readme
源码仓库：https://github.com/buka-inc/npm.class-transformer-extra

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

- 包体积（解压后）：49.2 kB，91 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- peer 依赖：class-transformer ^0\.5\.1，class-validator ^0\.14\.1
- 首次发布：2024-01-08T15:07:04.508Z
- 最新版本发布：2024-12-18T17:53:51.035Z
- 近 30 天下载量：47759（2026-10-09 至 2026-11-07，npm 官方下载统计）
- 已发布版本数：7（近 12 个月 0 个）

## 中文简介

class-transformer-extra中包含不包含在类-transform包中的方法.

## 安装

```sh
npm install @buka/class-transformer-extra
```

也可以使用：`pnpm add @buka/class-transformer-extra`、`yarn add @buka/class-transformer-extra`、`bun add @buka/class-transformer-extra`

## README

# @buka/ class- transfer-extra

[![version](https://img.shields.io/npm/v/@buka/class-transformer-extra.svg?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/@buka/class-transformer-extra) [![downloads](https://img.shields.io/npm/dm/@buka/class-transformer-extra.svg?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/@buka/class-transformer-extra) [![dependencies](https://img.shields.io/librariesio/release/npm/@buka/class-transformer-extra?logo=npm&style=for-the-badge)](https://www.npmjs.com/package/@buka/class-transformer-extra) [![license](https://img.shields.io/npm/l/@buka/class-transformer-extra.svg?logo=github&style=for-the-badge)](https://www.npmjs.com/package/@buka/class-transformer-extra) [![Codecov](https://img.shields.io/codecov/c/gh/buka-lnc/npm.class-transformer-extra?logo=codecov&token=PLF0DT6869&style=for-the-badge)](https://codecov.io/gh/buka-lnc/npm.class-transformer-extra)

`@buka/class-transformer-extra` 包含不包含在 [`class-transformer`](https://github.sheincorp.cn/typestack/class-transformer) 软件包.

## 安装

```shell
npm install @buka/class-transformer-extra class-transformer
# OR
yarn install @buka/class-transformer-extra class-transformer
# OR
pnpm install @buka/class-transformer-extra class-transformer
```

## 使用量

### 字符串

| 方法 | 在变压器之前 | 变压器之后 |
| :-- | :-- | :-- |
| `@Split(",")` | `"a,b,c"` | `["a", "b", "c"]` |
| `@Trim()` | `" abc "` | `"abc"` |
| `@ToString({ optional: true })` | `123` | `"123"` |
| `@ToLowerCase()` | `"ABC"` | `"abc"` |
| `@ToUpperCase()` | `"abc"` | `"ABC"` |
| `@Replace("-", "_")` | `"a-b-c"` | `"a_b_c"` |

> `@Split`, (中文(简体) ), `@Trim`, (中文(简体) ), `@ToLowerCase`, (中文(简体) ), `@ToUpperCase` 财务报告和审定财务报表 `@Replace` 如果值不是字符串,则不会做任何事情. 设定时 `optional: true`, (中文(简体) ), `undefined` 将不会改变.

### 日期

| 方法 | 在变压器之前 | 变压器之后 |
| :-- | :-- | :-- |
| `@ToDate({ optional: true })` | `"2024-01-01"` | `new Date("2024-01-01")` |
| `@FormatDate("YYYY/MM/DD", { optional: true })` | `"2024-01-01"` | `"2024/01/01"` |

### 数目

| 方法 | 在变压器之前 | 变压器之后 |
| :-- | :-- | :-- |
| `@ToNumber({ optional: true })` | `"123"` | `123` |
| `@ToBigInt({ optional: true })` | `"123"` | `123n` |

> `ToNumber()` 财务报告和审定财务报表 `@ToBigInt()` 如果数值不是数字, 将会返回 NaN

### 布尔

| 方法 | 在变压器之前 | 变压器之后 |
| :-- | :-- | :-- |
| `@ToBoolean()` | `1` | `true` |

> `ToBoolean()` 有多个参数来适应不同的需要,例如:
> 
> > `ToBoolean(v => Boolean(v)), { optional: true })`数字 : 如果值是 `undefined`什么都别做 否则, `v => Boolean(v)` 将用来转换值.
> 
> > `ToBoolean(['0', 'false', false], { optional: true })`数字 :
> > 
> > 如果值是 `'0'` 或者说 `'false'` 或者说 `false`,转换为 `false`,如果值为 `undefined`,不做任何事情,否则价值将转换为 `true`。 。 。 .

### 阵列

| 方法 | 在变压器之前 | 变压器之后 |
| :-- | :-- | :-- |
| `@Filter((num: number) => num > 3)` | `[1,2,3.4,5]` | `[4,5]` |
| `@Flatten()` | `[1, [2, [3, 4, [5]]]]` | `[1,2,3,4,5]` |
| `@Uniq()` | `[1,1,2,3,4,4,5]` | `[1,2,3,4,5]` |
| `@UniqBy(Math.abs)` | `[-1, 1, 2, 3, -3]` | `[-1, 2, 3]` |

> `@Filter`, (中文(简体) ), `@Flatten`, (中文(简体) ), `@Uniq` 财务报告和审定财务报表 `@UniqBy` 如果值不是数组,则将不采取任何行动.

## 贡献

如果您想要报告错误或添加新的装饰器, 请提交问题或拉请求 .

## Q&A

1.  为什么不能用它与 `@IsOptional` 装饰师?
    
    最新版本为 `class-validator@^0.14.1` 没有设置可以识别的元数据 `@IsOptional`。 。 。 . 如果在以后的版本中添加识别资料,我也将采取后续行动。 在开发分支中添加了标识符 `class-validator`。 。 。 .

## 常见问题

### @buka/class-transformer-extra 是什么？

class-transformer-extra中包含不包含在类-transform包中的方法\.

### 如何安装 @buka/class-transformer-extra？

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

### @buka/class-transformer-extra 支持 TypeScript 吗？

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

### @buka/class-transformer-extra 支持 ESM 还是 CommonJS？

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

### @buka/class-transformer-extra 可以商用吗？

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

### @buka/class-transformer-extra 的下载量有多少？

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

### @buka/class-transformer-extra 还在维护吗？

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