docs: Update adapter documentation #3249
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
add type annotation / fix type annotation for the common adapter options. directly copy updated documentation into the knex / mongodb sections so they are exactly the same (including now lisitng some options as deprecated and correctly stating that the default `id` for knex is `'id'`)
daffl
approved these changes
Aug 8, 2023
daffl
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary of Problem
The current knex docs incorrectly refer to mongodb in the knex documentation, they state that the default id is
'_id', and they mention the events option which has been deprecated. The mongodb docs similarly mention the deprecated events option.The common adapters documentation does not have type descriptions for the options while the knex and mongodb docs do.
What did I do
Add /fix type annotation for the common adapter options. Directly copy updated documentation into the knex / mongodb sections so they are exactly the same and mention/link to the other, deprecated options