@gapi/sequelize

中文文档
1.8.263发布于 2026/11/16MITTypeScriptESM + CJS近 30 天下载 4326
原始使用文档

@Gapi/Sequelize

@Gapi Sequelize module @StrongTyped

For questions/issues you can write ticket here
This module is intended to be used with GAPI

Installation and basic examples:

To install this Gapi module, run:
$ npm install @gapi/sequelize --save

Consuming gapi-sequelize

Import inside AppModule or CoreModule
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 {}
Create folder root/src/models and put this testing User Typescript-Sequelize Model with Uppercase name example: "User.ts"
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;
}
Final use this class inside your services the following way
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,
      },
    });
  }
}

Advanced getting sequelize instance to manage your sequelize connection

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,
    });
  }
}

Next import SequelizePrivateService inside Core or AppModule

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: Better documentation...

Enjoy ! :)

版本与发布记录

@gapi/sequelize 共发布 793 个版本,首次发布于 2018/03/23;过去 12 个月发布了 116 个版本。

版本发布日期距今
1.8.263latest2026/11/16今天
1.8.2622026/11/132 天前
1.8.2612026/11/096 天前
1.8.2602026/11/097 天前
1.8.2592026/11/097 天前
1.8.2582026/11/078 天前

其他发布通道:nightly → 1.8.168-nightly.3。

关于 @gapi/sequelize 的常见问题

如何安装 @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 和提交记录判断。