docs(techniques): Make the use of ObjectId less ambiguous #3201
+21
−0
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.
Clarify how to get better typesafety when using
mongoose.Schema.Types.ObjectId
as a type in@Prop()
PR Checklist
Please check if your PR fulfills the following requirements:
PR Type
What kind of change does this PR introduce?
What is the current behavior?
Issue Number: N/A
What is the new behavior?
I want clear up some documentation that I think is confusing to people that are new to typescript / nestjs / mongoose.
I think it was not clear enough what the correct type should be if people choose to not populate the references on mongoose schemas.
I added some examples and comments about how you might go about adding
mongoose.Schema.Types.ObjectId
s to the schemas if you don't plan on always populating those.Thank you for a lovely library.
Does this PR introduce a breaking change?
Other information