Model.$set definition conflicts with implementation

[katanacrimson]

As above. Typescript is currently throwing a fit, because...

This

$set<R extends Model<R>>(propertyKey: string, instances: R|R[], options?: IAssociationActionOptions): Promise<this>;

and this

$set(propertyKey: string, instances: any, options: any): Promise<this> {

are incompatible.

Right now, Typescript is insisting that the third parameter for $set must conform to the interface IAssociationActionOptions, which both conflicts with the implementation and prevents passing save: false, which is useful when creating multiple associations while disallowing null values.

Example:

    const xref = new UsergroupPermissions({
      value: PermissionValue.NO
    })
    await xref.$set('usergroup', usergroup, { save: false })
    await xref.$set('permission', permission, { save: false })
    await xref.save()

    // ...

Resulting Typescript error:

    (52, 47) Argument of type '{ save: boolean; }' is not assignable to parameter of type 'IAssociationActionOptions | undefined'.

[RobinBuschmann]

@damianb So save: boolean is missing in IAssociationActionOptions, right? Can you provide a link to the docs describing these options? I couldn't find them. Thank you :)

[katanacrimson]

Not sure if it's that it is missing from the interface, or if the interface itself for $set's options is distinct in and of itself.

This is what I was looking at:

http://docs.sequelizejs.com/class/lib/associations/belongs-to.js~BelongsTo.html#instance-method-set

For context, I'm basically doing the model for the xref table in a many-to-many right now, where it also holds an extra column for some additional metadata.

[RobinBuschmann]

@damianb Sry for the late response. I found the set methods in the sequelize docs: http://docs.sequelizejs.com/class/lib/associations/has-many.js~HasMany.html#instance-method-set

Unfortunately it doesn't seem to have a save option. Can you confirm that it is working anyway with save: false? In this case, we could add it to the typings anyway. Thank you

[katanacrimson]

Iiiinteresting...looking at the sequelize source, it seems you're right for the rest.

Though, looking at the BelongsTo definition, it should still work in my case; I'm trying to set their relationship via the xref table (because I have an additional column that needs set...), and I'm using BelongsTo like below:

export class UsergroupPermission extends Model<UsergroupPermission> {
  @ForeignKey(() => Permission)
  @AllowNull(false)
  @Column({
    unique: 'UserGroupPermission'
  })
  public PermissionId: number

  @ForeignKey(() => Usergroup)
  @AllowNull(false)
  @Column({
    unique: 'UserGroupPermission'
  })
  public UsergroupId: number

  @AllowNull(false)
  @Column({
    type: DataType.ENUM(...PermissionValueArray),
    comment: 'The value of the specified permission for the given UserGroup.'
  })
  public value: PermissionValue

  @BelongsTo(() => Permission)
  public permission: Permission

  @BelongsTo(() => Usergroup)
  public usergroup: Usergroup
}

So, correct me if I'm wrong - I'd figure that if I'm using UsergroupPermission.$set() on the permission and usergroup properties, it should still be allowing and obeying the save option because, in the end, those are BelongsTo associations.

I'll have to shoehorn it somehow to see if I can later. Will give it a shot when I can.

[typeofweb]

Any plans to change the typing to include save: boolean?

According to the Sequelize docs, save is only supported for BelongsTo relations @RobinBuschmann: http://docs.sequelizejs.com/class/lib/associations/belongs-to.js~BelongsTo.html#instance-method-set