Skip to content

Commit

Permalink
updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
HRM committed Sep 8, 2024
1 parent ae9309f commit 0dcf7f4
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
# Prisma Nitro Patcher 🩹

As reported by some users in the past, there are and were some ongoing issues with the typing performance of the prisma client when a large schema is combined with client extensions ([1](https://github.com/prisma/prisma/issues/4807#issuecomment-2239542737),[2](https://github.com/prisma/prisma/issues/23761),[3](https://github.com/prisma/prisma/issues/17843)). This tool is developed to provide an alternative route for those who need a quick solution, **till the prisma team introduces some fix**. It mostly builds on the type system provided by the prisma team with some small alterations, it only changes the generated index.d.ts, there is no change in runtime behavior. **Use it for improved editor and compilation performance.**
Some users have reported ongoing issues with the typing performance of the Prisma client, particularly when a large schema is combined with client extensions (see [1](https://github.com/prisma/prisma/issues/4807#issuecomment-2239542737), [2](https://github.com/prisma/prisma/issues/23761), and [3](https://github.com/prisma/prisma/issues/17843)). This tool offers an alternative solution for those who need a quick fix until the Prisma team releases an official patch. It builds primarily on the type system provided by the Prisma team but introduces some modifications. It only alters the generated `index.d.ts`, ensuring there is no change in runtime behavior. **If you're experiencing issues with extensions, use this tool to improve your editor and compilation performance.**
### Benefits and drawbacks

As this package provides only a patch witch is a bad practice on the long run, and probably it wont be required anyway, it wont reach major version 1
Depending on your use case, this patch can improve typing performance, potentially reducing performance loss by 20% to 70%. However, please note that the patch achieves this by simplifying the type system. As a result, you may experience a reduction in type checks. For most users, this should not pose a significant issue.

### Setup instructions

Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "prisma-nitro-patcher",
"version": "0.0.7",
"version": "0.0.8",
"description": "Applies a patch on the prisma client to improve the performance of extensions",
"files": [ "dist" ],
"bin": {
Expand Down

0 comments on commit 0dcf7f4

Please sign in to comment.