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

knex: rename connection object #1364

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

alxndrsn
Copy link
Contributor

@alxndrsn alxndrsn commented Jan 14, 2025

Renames the knex config object passed as connection to knex() from generic "connectionObject" to more specific "knexConnection".

This renaming will:

  • make intention/use of connectionObject clearer
  • ease finding of knex-related code across the repo
  • aid deprecating and finally removing knex dependency

What has been done to verify that this works as intended?

CI

Why is this the best possible solution? Were any other approaches considered?

Not really?

How does this change affect users? Describe intentional changes to behavior and behavior that could have accidentally been affected by code changes. In other words, what are the regression risks?

Should not impact users - it's just a variable/export rename.

Does this change require updates to the API documentation? If so, please update docs/api.yaml as part of this PR.

No.

Before submitting this PR, please make sure you have:

  • run make test and confirmed all checks still pass OR confirm CircleCI build passes
  • verified that any code from external sources are properly credited in comments or that everything is internally sourced

Renames the knex config object passed as `connection` to `knex()` from the generic `connectionObject` to `knexConnection`.

This renaming will:

* make intention/use of `connectionObject` clearer
* ease finding of knex-related code across the repo
* aid deprecating and finally removing knex dependency
@alxndrsn alxndrsn marked this pull request as ready for review January 14, 2025 11:21
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.

1 participant