解决Nestjs中Sequelize bulkCreate的TypeScript类型错误

问题 #

使用NestJS搭建后端服务，通过Sequelize实现批量插入功能时遇到TypeScript类型错误。

相关代码 #

OwnerService 代码：

export class OwnerService {
  constructor(
    @InjectModel(Owner)
    private ownerRepository: typeof Owner,
    @InjectModel(Wallet)
    private walletRepository: typeof Wallet,
  ) {}
  async bulkCreate(data: Owner[]) {
    this.ownerRepository.bulkCreate(data);
  }
}

Owner 实体定义：

@Table({ tableName: 'owner' })
export class Owner extends Model {
  @Column({
    type: DataType.INTEGER,
    primaryKey: true,
    autoIncrement: true,
  })
  id: number;

  @Column({
    type: DataType.STRING,
  })
  name: string;

  @Column({
    type: DataType.STRING,
  })
  address: string;

  @Column({
    type: DataType.STRING,
    field: 'public_key',
  })
  publicKey: string;

  @BelongsToMany(() => Wallet, () => WalletOwner)
  wallets: Wallet[];
}

报错信息 #

Argument of type 'Owner[]' is not assignable to parameter of type 'readonly Optional<any, string>[]'.
Type 'Owner' is not assignable to type 'Optional<any, string>'.
Type 'Owner' is not assignable to type 'Omit<any, string>'.
Index signature for type 'number' is missing in type 'Owner'

尝试自定义OwnerInterface后问题依旧，询问是否只能按照官方示例的方式实现批量插入。

官方示例代码：

this.ownerRepository.bulkCreate([
{name: "name1", address: "address1", publicKey: "publicKey1"},
{name: "name2", address: "address2", publicKey: "publicKey2"},
]);

解决方法 #

错误原因 #

Sequelize的bulkCreate方法期望接收纯数据对象数组（对应Model的可创建字段），而不是Owner实例数组。Owner是继承自Sequelize Model的类，实例包含Model的内置方法、关联属性等额外内容，不符合bulkCreate的参数类型要求。

具体解决方案 #

1. 使用Sequelize内置的CreationAttributes类型定义入参

Sequelize会为每个Model自动生成CreationAttributes<Model>类型，该类型自动排除主键（如id）、关联字段（如wallets）等不需要在创建时传入的属性，完美匹配bulkCreate的参数要求：

import { CreationAttributes } from 'sequelize';

export class OwnerService {
  // ... 构造函数省略
  async bulkCreate(data: CreationAttributes<Owner>[]) {
    return this.ownerRepository.bulkCreate(data);
  }
}

2. 若需传入Owner实例数组，先转换为纯数据对象

如果业务场景必须传入Owner实例，可通过get({ plain: true })方法将实例转为纯数据对象，再过滤掉不需要的字段：

async bulkCreate(owners: Owner[]) {
  // 转换为纯数据对象
  const rawData = owners.map(owner => owner.get({ plain: true }));
  // 过滤主键和关联字段
  const createData = rawData.map(({ id, wallets, ...rest }) => rest);
  return this.ownerRepository.bulkCreate(createData);
}

3. 为什么自定义OwnerInterface无效？

自定义接口没有和Sequelize的类型系统绑定，无法自动适配bulkCreate的参数约束。使用Sequelize提供的CreationAttributes类型能确保类型检查的准确性，避免手动维护接口的疏漏。

总结 #

不需要完全照搬官方示例的字面量写法，只要保证传入的是符合CreationAttributes<Owner>结构的纯数据对象数组即可。使用Sequelize内置类型既能满足类型检查，又能提升代码的可维护性。

内容的提问来源于stack exchange，提问作者Champer Wu