Skip to content

fix(types): allow any values in isIn validator #12962

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

Merged
sdepold merged 6 commits into from
Oct 24, 2021
Merged

fix(types): allow any values in isIn validator #12962

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
0dd9c09
fix(types): allow any values in `isIn` validator
lukashroch Jan 20, 2021
c1487de
test(types): isIn/notIn validation type tests
lukashroch Jun 25, 2021
8cfbc4a
Merge branch 'main' into isIn-fix
lukashroch Jun 25, 2021
051a507
Merge branch 'main' into isIn-fix
sdepold Oct 16, 2021
3dd25a1
Merge branch 'main' into isIn-fix
sdepold Oct 23, 2021
5a989ec
Merge branch 'main' into isIn-fix
sdepold Oct 24, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions types/lib/model.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1109,13 +1109,13 @@ export interface ModelValidateOptions {
/**
* check the value is not one of these
*/
notIn?: ReadonlyArray<readonly string[]> | { msg: string; args: ReadonlyArray<readonly string[]> };
notIn?: ReadonlyArray<readonly any[]> | { msg: string; args: ReadonlyArray<readonly any[]> };

/**
* check the value is one of these
*/
isIn?: ReadonlyArray<readonly string[]> | { msg: string; args: ReadonlyArray<readonly string[]> };

isIn?: ReadonlyArray<readonly any[]> | { msg: string; args: ReadonlyArray<readonly any[]> };
/**
* don't allow specific substrings
*/
Expand Down
22 changes: 22 additions & 0 deletions types/test/validators.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import { DataTypes, Model, Sequelize } from 'sequelize';

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

/**
* Test for isIn/notIn validation - should accept any[]
*/
class ValidatedUser extends Model {}
ValidatedUser.init({
name: {
type: DataTypes.STRING,
validate: {
isIn: [['first', 1, null]]
}
},
email: {
type: DataTypes.STRING,
validate: {
notIn: [['second', 2, null]]
Copy link
Copy Markdown
Member

@sdepold sdepold Oct 16, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would have somehow expected that we would have e.g. an INTEGER column and hence verify that the value is no part of a list of numbers or so.

Also, is that syntax correct? Why array of array and not ['first', 1, null]

Copy link
Copy Markdown
Contributor Author

@lukashroch lukashroch Oct 16, 2021 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

test was written to demonstrate that type works, i.e. it accepts other types not just string. Real world would be different, as you say e.g. list of int and int data type.

Syntax is how sequelize implements it (https://github.com/sequelize/sequelize/blob/main/types/lib/model.d.ts#L1112 or https://sequelize.org/master/manual/validations-and-constraints.html), I haven't really change that. Just a type since validator.js allows any for this validation.

}
},
}, { sequelize });