feat: mention PromiseReturnType alternative #6920
Merged
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
Dangerous URL checkNo absolute URLs to prisma.io/docs found. |
Redirect checkThis PR probably requires the following redirects to be added to static/_redirects:
|
Deploying docs with
|
| Latest commit: |
4b3a185
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://114a64b0.docs-51g.pages.dev |
| Branch Preview URL: | https://da-3519.docs-51g.pages.dev |
nikolasburk
reviewed
May 21, 2025
...00-prisma-client/400-type-safety/100-operating-against-partial-structures-of-model-types.mdx
Outdated
Show resolved
Hide resolved
…g-against-partial-structures-of-model-types.mdx
nikolasburk
reviewed
May 21, 2025
...00-prisma-client/400-type-safety/100-operating-against-partial-structures-of-model-types.mdx
Outdated
Show resolved
Hide resolved
…g-against-partial-structures-of-model-types.mdx
nikolasburk
approved these changes
May 21, 2025
aqrln
reviewed
May 21, 2025
| You can use native the TypeScript utility type [`Awaited`](https://www.typescriptlang.org/docs/handbook/utility-types.html#awaitedtype) and [`ReturnType`](https://www.typescriptlang.org/docs/handbook/utility-types.html#returntypetype) to solve the problem elegantly: | ||
|
|
||
| ```ts | ||
| type UsersWithPosts = Prisma.Awaited<ReturnType<typeof getUsersWithPosts>> |
There was a problem hiding this comment.
This should be Awaited and not Prisma.Awaited, it's a built-in type in TypeScript.
aqrln
reviewed
May 21, 2025
| type UsersWithPosts = Prisma.Awaited<ReturnType<typeof getUsersWithPosts>> | ||
| ``` | ||
|
|
||
| When using the `prisma-client-js` generator, a `PromiseReturnType` is exposed by the `Prisma` namespace, you can solve the problem using the `PromiseReturnType` type: |
There was a problem hiding this comment.
I am not convinced we still need to mention that PromiseReturnType exists at all. I would just rewrite this section to use Awaited<ReturnType<typeof getUsersWithPosts>> and that's it. Mentioning both seems redundant and potentially confusing for users to me.
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.
No description provided.