Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

fix(types): align the return value of increment and decrement with actual behavior #14704

Merged
merged 10 commits into from Jul 8, 2022
Merged

fix(types): align the return value of increment and decrement with actual behavior #14704

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
c9acb95
fix(typings): returns same value from increment and decrement function
fzn0x Jun 30, 2022
1ae5579
fix(typings): affected rows was declared within an array
fzn0x Jun 30, 2022
caf90de
Merge branch 'main' into increment-related-typings
fzn0x Jul 5, 2022
83f8c0e
feat(types): migrate #14145
fzn0x Jul 5, 2022
f0ae5f2
test: migrate #14145
fzn0x Jul 5, 2022
05debc8
fix: adopt eslint new rules to migrated code
fzn0x Jul 5, 2022
34cca12
test: fix overload
fzn0x Jul 5, 2022
62bd444
fix: error TS2304 Cannot find name 'M'.
fzn0x Jul 5, 2022
63a4a32
Merge branch 'main' into increment-related-typings
fzn0x Jul 5, 2022
bb38ed3
Merge branch 'main' into increment-related-typings
fzn0x Jul 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 6 additions & 6 deletions src/model.d.ts
View file
Open in desktop
Expand Up @@ -2831,18 +2831,18 @@ export abstract class Model<TModelAttributes extends {} = any, TCreationAttribut
* value of `by` given in options. If an array is provided, the same is true for each column.
* If an object is provided, each key is incremented by the corresponding value, `by` is ignored.
*
* @returns an array of affected rows and affected count with `options.returning` true, whenever supported by dialect
* @returns an array of affected rows or with affected count if `options.returning` is true, whenever supported by dialect
*/
static increment<M extends Model>(
this: ModelStatic<M>,
fields: AllowReadonlyArray<keyof Attributes<M>>,
options: IncrementDecrementOptionsWithBy<Attributes<M>>
): Promise<[affectedRows: M[]]>;
): Promise<[affectedRows: M[], affectedCount?: number]>;
static increment<M extends Model>(
this: ModelStatic<M>,
fields: { [key in keyof Attributes<M>]?: number },
options: IncrementDecrementOptions<Attributes<M>>
): Promise<[affectedRows: M[]]>;
): Promise<[affectedRows: M[], affectedCount?: number]>;

/**
* Decrements the value of one or more attributes.
Expand All @@ -2853,20 +2853,20 @@ export abstract class Model<TModelAttributes extends {} = any, TCreationAttribut
* value of `by` given in options. If an array is provided, the same is true for each column.
* If an object is provided, each key is incremented by the corresponding value, `by` is ignored.
*
* @returns an array of affected rows and affected count with `options.returning` true, whenever supported by dialect
* @returns an array of affected rows or with affected count if `options.returning` is true, whenever supported by dialect
*
* @since 4.36.0
*/
static decrement<M extends Model>(
this: ModelStatic<M>,
fields: AllowReadonlyArray<keyof Attributes<M>>,
options: IncrementDecrementOptionsWithBy<Attributes<M>>
): Promise<M>;
): Promise<[affectedRows: M[], affectedCount?: number]>;
static decrement<M extends Model>(
this: ModelStatic<M>,
fields: { [key in keyof Attributes<M>]?: number },
options: IncrementDecrementOptions<Attributes<M>>
): Promise<M>;
): Promise<[affectedRows: M[], affectedCount?: number]>;

/**
* A hook that is run before validation
Expand Down
26 changes: 25 additions & 1 deletion test/types/model.ts
View file
Open in desktop
Expand Up @@ -87,6 +87,30 @@ MyModel.count({ group: 'type' }).then(result => {
expectTypeOf(result[0]).toMatchTypeOf<{ count: number }>();
});

MyModel.increment('int', { by: 1 }).then(result => {
expectTypeOf(result).toEqualTypeOf<[affectedRows: MyModel[], affectedCount?: number]>();
});

MyModel.increment({ int: 2 }, {}).then(result => {
expectTypeOf(result).toEqualTypeOf<[affectedRows: MyModel[], affectedCount?: number]>();
});

MyModel.increment(['int'], { by: 3 }).then(result => {
expectTypeOf(result).toEqualTypeOf<[affectedRows: MyModel[], affectedCount?: number]>();
});

MyModel.decrement('int', { by: 1 }).then(result => {
expectTypeOf(result).toEqualTypeOf<[affectedRows: MyModel[], affectedCount?: number]>();
});

MyModel.decrement({ int: 2 }, {}).then(result => {
expectTypeOf(result).toEqualTypeOf<[affectedRows: MyModel[], affectedCount?: number]>();
});

MyModel.decrement(['int'], { by: 3 }).then(result => {
expectTypeOf(result).toEqualTypeOf<[affectedRows: MyModel[], affectedCount?: number]>();
});

MyModel.build({ int: 10 }, { include: OtherModel });

MyModel.bulkCreate([{ int: 10 }], { include: OtherModel, searchPath: 'public' });
Expand All @@ -109,7 +133,7 @@ MyModel.update({}, { where: { str: 'bar' }, returning: ['str'] }).then(result =>

const sequelize = new Sequelize('mysql://user:user@localhost:3306/mydb');

const model: typeof MyModel = MyModel.init({
MyModel.init({
int: DataTypes.INTEGER,
str: DataTypes.STRING,
virtual: {
Expand Down