# @gapi/sequelize 中文文档

规范地址：https://npmcn.com/package/%40gapi/sequelize/

版本：1\.8\.263
npm 元数据更新时间：2026-11-15T16:24:54.469Z
中文译文更新时间：2026-11-15T23:07:34.097Z
软件包许可：MIT

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

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

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

- 包体积（解压后）：12.7 kB，14 个文件
- 模块格式：ESM + CJS
- TypeScript 类型：包内自带
- 运行依赖：2 个
- 首次发布：2018-03-22T22:26:52.824Z
- 最新版本发布：2026-11-15T16:24:54.292Z
- 近 30 天下载量：4326（2026-10-16 至 2026-11-14，npm 官方下载统计）
- 已发布版本数：793（近 12 个月 116 个）

## 中文简介

暂无中文简介

## 安装

```sh
npm install @gapi/sequelize
```

也可以使用：`pnpm add @gapi/sequelize`、`yarn add @gapi/sequelize`、`bun add @gapi/sequelize`

## README

# @ Gapi/ 分类

#### @ Gapi 序列化模块@ strongTyped

##### 问题/问题可写票 [这里](https://github.com/Stradivario/gapi/issues)

##### 本模块意在与 [冈比亚](https://github.com/Stradivario/gapi)

## 安装和基本实例:

##### 要安装 Gapi 模块, 请运行 :

```bash
$ npm install @gapi/sequelize --save
```

## 空档排序

##### 在 AppModule 或 CoreModule 内导入

```typescript
import { Module } from '@rxdi/core';
import { SequelizeModule } from '@gapi/sequelize';

@Module({
  imports: [
    SequelizeModule.forRoot({
      dialect: 'postgres',
      host: process.env.DB_HOST || '',
      port: process.env.DB_PORT || 5432,
      username: process.env.DB_USERNAME || '',
      password: process.env.DB_PASSWORD || '',
      database: process.env.DB_NAME || 'your-database',
      storage: ':memory:',
      logging: false,
      modelPaths: [process.cwd() + '/src/models'],
      force: false,
    }),
  ],
})
export class CoreModule {}
```

##### 创建文件夹 root/ src/ models 并将此测试用户 Typescript- Sequelize Model 以大写名为例:“ User.ts”

```typescript
import {
  Table,
  Column,
  Model,
  CreatedAt,
  UpdatedAt,
  DeletedAt,
  PrimaryKey,
  AutoIncrement,
  HasMany,
  DataType,
  BelongsToMany,
} from 'sequelize-typescript';

export interface UserSettings {
  sidebar: boolean;
}

@Table
export class User extends Model<User> {
  @PrimaryKey
  @AutoIncrement
  @Column
  id: number;

  @Column
  name: string;

  @Column({
    type: DataType.ENUM({ values: ['ADMIN', 'USER'] }),
  })
  type: 'ADMIN' | 'USER';

  @Column({
    type: DataType.JSONB,
    allowNull: true,
  })
  settings: UserSettings;

  @CreatedAt
  creationDate: Date;

  @UpdatedAt
  updatedOn: Date;

  @DeletedAt
  deletionDate: Date;
}
```

##### 最终在您服务范围内使用此类 :

```typescript
import { Service } from '@rxdi/core';
import { UserType } from '../types/user.type';
import { User } from '../../../models/User';

@Service()
export class AnotherService {
  trimFirstLetter(username: string): string {
    return username.charAt(1);
  }
}

@Service()
export class UserService {
  constructor(private anotherService: AnotherService) {}

  async findUser(id: number): Promise<User> {
    return await User.findOne({ where: { id: id } });
  }

  async addUser(user: User): Promise<User> {
    return await User.create(user);
  }

  async deleteUser(id: number) {
    return await User.destroy({ where: { id: id } });
  }

  async updateUser(user: User) {
    return await User.update(user, {
      where: {
        id: user.id,
      },
    });
  }
}
```

#### 高级后继实例管理您的后继连接

```typescript
import { Service } from '@rxdi/core';
import { SequelizeService } from '@gapi/sequelize';

@Service()
export class SequelizePrivateService
  extends SequelizeService
  implements SequelizeService {
  sequelize: Sequelize;
  constructor() {
    super({
      dialect: 'postgres',
      host: process.env.DB_HOST || '',
      port: process.env.DB_PORT || '5432',
      username: process.env.DB_USERNAME || '',
      password: process.env.DB_PASSWORD || '',
      name: process.env.DB_NAME || 'your-database',
      storage: ':memory:',
      logging: false,
      modelPaths: [process.cwd() + '/src/models'],
      force: false,
    });
  }
}
```

#### 下次导入 Core 或 AppModule 内部的私密服务序列

```typescript
import { Module } from '@rxdi/core';
import { SequelizeModule } from '@gapi/sequelize';
import { SequelizePrivateService } from './services/sequelize/sequelize.service.ts';

@Module({
  services: [SequelizePrivateService],
})
export class CoreModule {}
```

TODO: 更好的文档...

享受吧! (笑声)

## 常见问题

### 如何安装 @gapi/sequelize？

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

### @gapi/sequelize 支持 TypeScript 吗？

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

### @gapi/sequelize 支持 ESM 还是 CommonJS？

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

### @gapi/sequelize 可以商用吗？

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

### @gapi/sequelize 的下载量有多少？

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

### @gapi/sequelize 还在维护吗？

最新版本 1\.8\.263 发布于 2026/11/16（今天）；至今共发布 793 个版本，其中过去 12 个月发布了 116 个；首次发布于 2018/03/23。发布频率只是参考信号：功能稳定的工具可能很少需要更新，建议结合源码仓库的 issue 和提交记录判断。

