docs: add TypeScript Query guide with info on lean() + transform()
#15377
Conversation
This file contains hidden or 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
There was a problem hiding this comment.
Pull Request Overview
This PR updates the documentation by adding a guide for using Mongoose queries in TypeScript, especially focusing on recommendations for ordering the use of lean() and transform().
- Added a new "Queries in TypeScript" section
- Provided code examples demonstrating the proper use and common pitfalls of chaining lean() and transform()
- Clarified the recommendation to call lean() before transform() for proper type inference
Files not reviewed (1)
- docs/layout.pug: Language not supported
hasezoey
approved these changes
Apr 29, 2025
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.
Fix #15311
Summary
Add some recommendations on how to use
lean()andtransform()together based on discussion from #15311. Also good to have a "Queries" page for more info on how to use queries in TypeScript.Examples