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(techniques): Make the use of ObjectId less ambiguous #3201

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

Conversation

getTobiasNielsen
Copy link

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?

  • Bugfix
  • Feature
  • Code style update (formatting, local variables)
  • Refactoring (no functional changes, no api changes)
  • Build related changes
  • Docs
  • Other... Please describe:

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.ObjectIds 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?

  • Yes
  • No

Other information

Clarify how to get better typesafety when using `mongoose.Schema.Types.ObjectId` as a type in `@Prop()`
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