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.

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

docs(types): correct Model.init return type #12148

Merged
merged 1 commit into from
Apr 22, 2020

Conversation

sam-dt
Copy link
Contributor

@sam-dt sam-dt commented Apr 22, 2020

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

Resolves #12112

Correct the return type of Model.init from void to Model to match to the return type defined in the API reference (which is the correct one).

@codecov
Copy link

codecov bot commented Apr 22, 2020

Codecov Report

Merging #12148 into master will increase coverage by 21.48%.
The diff coverage is n/a.

Impacted file tree graph

@@             Coverage Diff             @@
##           master   #12148       +/-   ##
===========================================
+ Coverage   74.85%   96.34%   +21.48%     
===========================================
  Files          86       95        +9     
  Lines        8373     9220      +847     
===========================================
+ Hits         6268     8883     +2615     
+ Misses       2105      337     -1768     
Impacted Files Coverage Δ
lib/dialects/sqlite/index.js 100.00% <0.00%> (ø)
lib/dialects/sqlite/query.js 98.65% <0.00%> (ø)
lib/dialects/postgres/connection-manager.js 95.83% <0.00%> (ø)
lib/dialects/postgres/query.js 97.84% <0.00%> (ø)
lib/dialects/mariadb/connection-manager.js 100.00% <0.00%> (ø)
lib/dialects/sqlite/connection-manager.js 100.00% <0.00%> (ø)
lib/dialects/mariadb/query.js 87.78% <0.00%> (ø)
lib/dialects/postgres/index.js 100.00% <0.00%> (ø)
lib/dialects/mariadb/index.js 100.00% <0.00%> (ø)
lib/model.js 96.60% <0.00%> (+1.06%) ⬆️
... and 28 more

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 a1ec8a1...65d0c4b. Read the comment docs.

@sushantdhiman sushantdhiman merged commit e59b3ff into sequelize:master Apr 22, 2020
@sam-dt sam-dt deleted the modelInitReturnType branch April 22, 2020 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Model.init discrepancy between docs and type defs
2 participants