fix(types): add Buffer to WhereValue type

[fubar]

Pull Request check-list

Please make sure to review and check all of these items:

• Does npm run test or npm run test-DIALECT pass with this change (including linting)?
• Does the description below contain a link to an existing issue (Closes #[issue]) or a description of the issue you are solving?
• Have you added new tests to prevent regressions?
• Is a documentation update included (if this change modifies existing APIs, or introduces new ones)?
• Did you update the typescript typings accordingly (if applicable)?
• Did you follow the commit message conventions explained in CONTRIBUTING.md?

Description of change

where clauses that contain Buffer values (querying binary fields) fail Typescript validation due to a missing type declaration. Example:

Foo.findOne({
  where: { bar: Buffer.alloc(0) },
});

This PR adds the missing Buffer type to the WhereValue type definition.

I ran npm run test-typings

[codecov]

Codecov Report

Merging #11499 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master   #11499   +/-   ##
=======================================
  Coverage   96.27%   96.27%           
=======================================
  Files          94       94           
  Lines        9185     9185           
=======================================
  Hits         8843     8843           
  Misses        342      342

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update bd59b87...cfba292. Read the comment docs.

[SimonSchick]

Can you please add a test for this as well?

[fubar]

@SimonSchick if you tell me how, more than happy to. npm run test-typings is producing no output, even when I explicitly throw an error in any of the files in types/test.

[papb]

Hello! I see you are a first-time contributor, thank you for taking the time to help Sequelize! I hope to see more PRs from you in the future!

Testing the TypeScript typings consists simply on checking if some code can be compiled. In other words, a typings test is just some TS code that should compile. What it does when executed is irrelevant, the test is simply to compile it without errors, as can be seen in our CI configuration (using npm run test-typings) here and here. Since it's just a compilation, getting no output from it means that it passed. Getting a compilation error is a failure. Note that if you directly throw an error from your typings test code, the test will still pass because throwing an error is something that compiles just fine.

For good examples on how to write typescript typings, check the following PRs: #11368 #11379 #11520

Let me know if you need further help!

[fubar]

@papb right of course, makes sense. I've added a test for all WhereValue literals.

I've noticed some linting issues in those typescript files. What do you think of covering them under the existing eslint setup? Happy to put it a PR for it.

[SimonSchick]

I'd rather use TSLint for that until eslint is fully feature on-par with it, PR is welcome though :)

[fubar]

TSLint is reaching end of life on Jan 1st and will be officially replaced by ESLint (see palantir/tslint#4534). We've been using the typescript-eslint parser and plugin in our repos, which works pretty well and allows the same set of rules to be applied to JS and TS.

[SimonSchick]

I haven't checked on their progress, but that sounds promising feel free to ahead with that.

[fubar]

@papb quick follow-up - all tests are passing now.

[papb]

LGTM

[sushantdhiman]

🎉 This PR is included in version 5.19.7 🎉

The release is available on:

• npm package (@latest dist-tag)
• GitHub release

Your semantic-release bot 📦🚀