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(hooks): add documentation for connection hooks #10410

Merged
merged 1 commit into from
Feb 2, 2019

Conversation

schmod
Copy link
Contributor

@schmod schmod commented Feb 1, 2019

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 follow the commit message conventions explained in CONTRIBUTING.md?

Description of change

Adds documentation for the beforeConnect() and afterConnect() hooks, API documentation for providing global hook definitions when constructing a Sequelize instance, and the corresponding TypeScript types.

Additionally, this corrects the TypeScript types to make operatorsAliases an optional configuration property (which was discovered when writing tests for the new types).

@codecov
Copy link

codecov bot commented Feb 1, 2019

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master   #10410   +/-   ##
=======================================
  Coverage    96.3%    96.3%           
=======================================
  Files          92       92           
  Lines        9813     9813           
=======================================
  Hits         9450     9450           
  Misses        363      363
Impacted Files Coverage Δ
lib/sequelize.js 96.35% <ø> (ø) ⬆️

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 6e88855...3a2149f. Read the comment docs.

@sushantdhiman sushantdhiman merged commit 4c04999 into sequelize:master Feb 2, 2019
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.

None yet

2 participants