Update 140-shared-extensions.mdx #5277
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
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
janpio
commented
Sep 5, 2023
| @@ -13,21 +13,50 @@ If you would like to build a shareable extension, we also recommend using the [` | |||
|
|
|||
| </TopBlock> | |||
|
|
|||
| ## Create a generic extension | |||
| ## Install a shared extension | |||
There was a problem hiding this comment.
Move the "install" block to the top instead of hiding it at the bottom
|
This PR changes the following pages (Vercel Preview Deploy links): Changed Vercel links (Note that links will only be valid after Vercel preview deploy succeeded) |
janpio
commented
Sep 5, 2023
Comment on lines
+43
to
50
| ## Create a sharable extension | ||
|
|
||
| When you want to create extensions other users can use, and that are not tailored just for your schema, Prisma provides utilities to allow you to create shareable extensions. | ||
|
|
||
| To create a shareable extension: | ||
|
|
||
| 1. Define the extension as a module using `Prisma.defineExtension` | ||
| 2. Use one of the methods that begin with the `$all` prefix such as [`$allModels`](/concepts/components/prisma-client/client-extensions/model#add-a-custom-method-to-all-models-in-your-schema) or [`$allOperations`](/concepts/components/prisma-client/client-extensions/query#modify-all-prisma-client-operations) |
There was a problem hiding this comment.
New intro for the "create" section
|
This PR probably requires the following redirects to be added to vercel.json:
|
janpio
commented
Sep 5, 2023
Comment on lines
52
to
+56
| ### Define an extension | ||
|
|
||
| Use the `Prisma.defineExtension` method to make your extension shareable. You can use it to package the extension to either separate your extensions into a separate file or share it with other users as an npm package. | ||
|
|
||
| The benefit of `Prisma.defineExtension` is that it provides strict type checks and auto completion for authors of extension in development and users of shared extensions. |
There was a problem hiding this comment.
About Prisma.defineExtension
janpio
commented
Sep 5, 2023
|
|
||
| The benefit of `Prisma.defineExtension` is that it provides strict type checks and auto completion for authors of extension in development and users of shared extensions. | ||
|
|
||
| ### Use a generic method |
There was a problem hiding this comment.
Section about the generic methods
janpio
commented
Sep 5, 2023
| @@ -70,8 +99,14 @@ export default Prisma.defineExtension({ | |||
|
|
|||
| </details> | |||
|
|
|||
| ### Publishing the shareable extension to Npm | |||
There was a problem hiding this comment.
New headline to highlight how to publish to Npm
janpio
commented
Sep 5, 2023
Comment on lines
+106
to
+108
| ## Other considerations | ||
|
|
||
| bla bla, other things to be aware or take advantage of |
There was a problem hiding this comment.
New intro for the "other" stuff that comes below
janpio
commented
Sep 5, 2023
Comment on lines
116
to
141
| ## Install a packaged extension | ||
|
|
||
| In your project, you can install any Prisma Client extension that another user has published to `npm`. To do so, run the following command: | ||
|
|
||
| ```terminal | ||
| npm install prisma-extension-<package-name> | ||
| ``` | ||
|
|
||
| For example, if the package name for an available extension is `prisma-extension-find-or-create`, you could install it as follows: | ||
|
|
||
| ```terminal | ||
| npm install prisma-extension-find-or-create | ||
| ``` | ||
|
|
||
| To import the `find-or-create` extension from the example above, and wrap your client instance with it, you could use the following code. This example assumes that the extension name is `findOrCreate`. | ||
|
|
||
| ```ts | ||
| import findOrCreate from 'prisma-extension-find-or-create' | ||
|
|
||
| const xprisma = prisma.$extends(findOrCreate) | ||
| const user = await xprisma.user.findOrCreate({ ... }) | ||
|
|
||
| xprisma.user.findOrCreate() | ||
| ``` | ||
|
|
||
| When you call a method in an extension, use the constant name from your `$extends` statement, not `prisma`. In the above example,`xprisma.user.findOrCreate` works, but `prisma.user.findOrCreate` does not, because the original `prisma` is not modified. |
jharrell
reviewed
Oct 13, 2023
...200-concepts/100-components/02-prisma-client/053-client-extensions/140-shared-extensions.mdx
Outdated
Show resolved
Hide resolved
…t-extensions/140-shared-extensions.mdx Co-authored-by: Jon Harrell <[email protected]>
|
Fixed the conflict. Review and merge would be appreciated to avoid having to do that again. |
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.
see comments