# @eggjs/tegg-orm-decorator 中文文档

规范地址：https://npmcn.com/package/%40eggjs/tegg-orm-decorator/

版本：3\.88\.1
npm 元数据更新时间：2026-09-08T07:59:46.193Z
中文译文更新时间：2026-11-14T02:11:30.384Z
软件包许可：MIT

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

原始 npm 页面：https://www.npmjs.com/package/%40eggjs/tegg-orm-decorator
原文对照：https://npmcn.com/package/%40eggjs/tegg-orm-decorator/?lang=original
项目主页：https://github.com/eggjs/tegg
源码仓库：https://github.com/eggjs/tegg

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

- 包体积（解压后）：35.3 kB，31 个文件
- 模块格式：CommonJS
- TypeScript 类型：包内自带
- Node.js 要求：\>=14\.0\.0
- 运行依赖：6 个
- peer 依赖：leoric ^2\.6\.1
- 首次发布：2021-09-08T03:54:27.640Z
- 最新版本发布：2026-09-08T07:59:46.008Z
- 近 30 天下载量：2548（2026-10-13 至 2026-11-11，npm 官方下载统计）
- 已发布版本数：222（近 12 个月 71 个）

## 中文简介

调试或调试器

## 安装

```sh
npm install @eggjs/tegg-orm-decorator
```

也可以使用：`pnpm add @eggjs/tegg-orm-decorator`、`yarn add @eggjs/tegg-orm-decorator`、`bun add @eggjs/tegg-orm-decorator`

## README

# `@eggjs/tegg-orm-decorator`

## 安装

```shell
npm i --save @eggjs/tegg-orm-decorator
```

## 定义模型

```ts
import { Model, Attribute } from '@eggjs/tegg-orm-decorator';
import { DataTypes, Bone } from 'leoric';

@Model()
export class App extends Bone {
  @Attribute(DataTypes.STRING)
  name: string;
  @Attribute(DataTypes.STRING)
  desc: string;
}
```

## 使用模型

```ts
import { SingletonProto, Inject } from '@eggjs/tegg';
import { App } from './model/App';

@SingletonProto()
export class AppService {
  @Inject()
  App: typeof App;

  async createApp(data: {
    name: string;
    desc: string;
  }): Promise<App> {
    const bone = await this.App.create(data as any);
    return bone as App;
  }

  async findApp(name: string): Promise<App | null> {
    const app = await this.App.findOne({ name });
    return app as App;
  }
}

```

## 常见问题

### @eggjs/tegg-orm-decorator 是什么？

调试或调试器

### 如何安装 @eggjs/tegg-orm-decorator？

在项目目录运行 npm install @eggjs/tegg-orm-decorator，或使用 pnpm add / yarn add / bun add。它还需要宿主项目提供 peer 依赖：leoric（^2\.6\.1）。npm 7 及以上与 pnpm 8 及以上默认会自动安装必需的 peer 依赖，Yarn 需要手动安装。

### @eggjs/tegg-orm-decorator 支持 TypeScript 吗？

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

### @eggjs/tegg-orm-decorator 支持 ESM 还是 CommonJS？

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

### @eggjs/tegg-orm-decorator 需要什么版本的 Node\.js？

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

### @eggjs/tegg-orm-decorator 可以商用吗？

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

### @eggjs/tegg-orm-decorator 的下载量有多少？

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

### @eggjs/tegg-orm-decorator 还在维护吗？

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