fix(typings): restrict update typings (#13216) · sequelize/sequelize@63ceb73

2 files changed

lines changed

Original file line number	Diff line number	Diff line change
`@@ -2087,7 +2087,9 @@ export abstract class Model<TModelAttributes extends {} = any, TCreationAttribut`
`2087`	`2087`	`*/`
`2088`	`2088`	`public static update<M extends Model>(`
`2089`	`2089`	`this: ModelStatic<M>,`
`2090`		`-values: Partial<M['_attributes']>,`
	`2090`	`+values: {`
	`2091`	`+[key in keyof M['_attributes']]?: M['_attributes'][key] \| Fn \| Col \| Literal;`
	`2092`	`+},`
`2091`	`2093`	`options: UpdateOptions<M['_attributes']>`
`2092`	`2094`	`): Promise<[number, M[]]>;`
`2093`	`2095`
`@@ -2744,8 +2746,13 @@ export abstract class Model<TModelAttributes extends {} = any, TCreationAttribut`
`2744`	`2746`	`/**`
`2745`	`2747`	* This is the same as calling `set` and then calling `save`.
`2746`	`2748`	`*/`
`2747`		`-public update<K extends keyof this>(key: K, value: this[K], options?: InstanceUpdateOptions<TModelAttributes>): Promise<this>;`
`2748`		`-public update(keys: object, options?: InstanceUpdateOptions<TModelAttributes>): Promise<this>;`
	`2749`	`+public update<K extends keyof TModelAttributes>(key: K, value: TModelAttributes[K] \| Col \| Fn \| Literal, options?: InstanceUpdateOptions<TModelAttributes>): Promise<this>;`
	`2750`	`+public update(`
	`2751`	`+keys: {`
	`2752`	`+[key in keyof TModelAttributes]?: TModelAttributes[key] \| Fn \| Col \| Literal;`
	`2753`	`+},`
	`2754`	`+options?: InstanceUpdateOptions<TModelAttributes>`
	`2755`	`+): Promise<this>;`
`2749`	`2756`
`2750`	`2757`	`/**`
`2751`	`2758`	`* Destroy the row corresponding to this instance. Depending on your setting for paranoid, the row will`

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { Model } from 'sequelize';`
	`1`	`+import { Model, fn, col, literal } from 'sequelize';`
`2`	`2`	`import { User } from './models/User';`
`3`	`3`
`4`	`4`	`class TestModel extends Model {`
`@@ -11,8 +11,27 @@ TestModel.update({}, { where: {}, returning: ['foo'] });`
`11`	`11`
`12`	`12`
`13`	`13`	`User.update({}, { where: {} });`
	`14`	`+User.update({`
	`15`	`+id: 123,`
	`16`	`+username: fn('FN'),`
	`17`	`+firstName: col('id'),`
	`18`	`+lastName: literal('Smith'),`
	`19`	`+}, { where: {} });`
`14`	`20`	`User.update({}, { where: {}, returning: true });`
`15`	`21`	`User.update({}, { where: {}, returning: false });`
`16`	`22`	`User.update({}, { where: {}, returning: ['username'] });`
`17`		`-// @ts-expect-error`
	`23`	`+User.build().update({`
	`24`	`+id: 123,`
	`25`	`+username: fn('FN'),`
	`26`	`+firstName: col('id'),`
	`27`	`+lastName: literal('Smith'),`
	`28`	`+});`
	`29`	+// @ts-expect-error invalid `returning`
`18`	`30`	`User.update({}, { where: {}, returning: ['foo'] });`
	`31`	+// @ts-expect-error no `where`
	`32`	`+User.update({}, {});`
	`33`	`+// @ts-expect-error invalid attribute`
	`34`	`+User.update({ foo: '<bar>' }, { where: {} });`
	`35`	`+// @ts-expect-error invalid attribute`
	`36`	`+User.build().update({ foo: '<bar>' });`
	`37`	`+`