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(sequelize): typing of upsert interface to match code (#11673) #11674

Merged
merged 2 commits into from Nov 13, 2019

Conversation

james-dietz
Copy link
Contributor

@james-dietz james-dietz commented Nov 12, 2019

Closes #11673

@codecov
Copy link

@codecov codecov bot commented Nov 12, 2019

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #11674   +/-   ##
=======================================
  Coverage   96.26%   96.26%           
=======================================
  Files          94       94           
  Lines        9190     9190           
=======================================
  Hits         8847     8847           
  Misses        343      343

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 c3dd6a3...dcbaf6b. Read the comment docs.

@papb
Copy link
Member

@papb papb commented Nov 12, 2019

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!

Please add at least one test to make sure your implementation works as intended and to prevent regressions in the future. Take a look into recent merged PRs to see how others created tests. If you have trouble, let me know.

@papb papb added status: awaiting response type: typescript labels Nov 12, 2019
@papb
Copy link
Member

@papb papb commented Nov 12, 2019

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!

@james-dietz
Copy link
Contributor Author

@james-dietz james-dietz commented Nov 12, 2019

Hopefully that should cover it. Thank you for the info on how to test that properly and getting back to me promptly!

papb
papb approved these changes Nov 13, 2019
@papb papb merged commit 149e0c7 into sequelize:master Nov 13, 2019
4 checks passed
@james-dietz james-dietz deleted the fix/issue-11673 branch Nov 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
status: awaiting response type: typescript
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants