feat(client): add more jsdoc to Prisma Client#4388
Merged
timsuchanek merged 12 commits intomasterfrom Dec 17, 2020
Merged
Conversation
williamluke4
force-pushed
the
williamluke4/issue4344
branch
3 times, most recently
from
e17bbf0 to
2adfbe3
Compare
williamluke4
force-pushed
the
williamluke4/issue4344
branch
4 times, most recently
from
eaa1189 to
267effa
Compare
williamluke4
commented
Dec 9, 2020
timsuchanek
reviewed
Dec 10, 2020
timsuchanek
reviewed
Dec 10, 2020
| groupByRootField.args | ||
| .map((arg) => new InputField(arg, false, arg.name === 'by').toTS()) | ||
| .map((arg) => { | ||
| arg.comment = getArgFieldJSDoc(model, DMMF.ModelAction.groupBy, arg) |
Contributor
There was a problem hiding this comment.
Could you build that into InputField?
Author
There was a problem hiding this comment.
I would have done that but it would take a while to implement
timsuchanek
reviewed
Dec 10, 2020
| : '' | ||
| }: Subset<T, ${getModelArgName(name, actionName)}> | ||
| ${actionName}${getGenericMethod(name, actionName)}( | ||
| ${getArgs(name, actionName)} |
Contributor
There was a problem hiding this comment.
Where did the conditions go?
timsuchanek
reviewed
Dec 10, 2020
timsuchanek
reviewed
Dec 10, 2020
timsuchanek
reviewed
Dec 10, 2020
williamluke4
force-pushed
the
williamluke4/issue4344
branch
3 times, most recently
from
01ed01c to
9ba457c
Compare
Jolg42
reviewed
Dec 10, 2020
| **/ | ||
| cursor?: PostWhereUniqueInput | ||
| /** | ||
| * The number of Posts to aggregate. If negative number, it will take Posts before the \`cursor\`. |
Contributor
There was a problem hiding this comment.
It will actually take the cursor too in results without skip: 1
So we need to find a better wording because "before" makes me think the cursor is not included but it is and you need to pass skip: 1 to exclude it
Example from docs
Example: Paging backwards with cusor-based pagination
To page backwards, set take to a negative value. The following query returns 4 Post records with an id of less than 200, excluding the cursor:
const myOldCursor = 200
const firstQueryResults = prisma.post.findMany({
take: -4,
skip: 1,
cursor: {
id: myOldCursor,
},
where: {
title: {
contains: 'Prisma' /* Optional filter */,
},
},
})
Author
There was a problem hiding this comment.
Takes n Posts from the position of the cursor, including the cursor?
Contributor
There was a problem hiding this comment.
Takes n Posts from the position of the cursor, cursor included. maybe
Author
There was a problem hiding this comment.
I have changed it to
Take \`n\` Posts from the position of the cursor (cursor included). If negative number, it will take Posts before the \`cursor\`.
Contributor
There was a problem hiding this comment.
So the cursor is always included from what I understand.
This suggests the cursor is included only in one case
williamluke4
force-pushed
the
williamluke4/issue4344
branch
3 times, most recently
from
2e2c8be to
f8bb1fe
Compare
williamluke4
force-pushed
the
williamluke4/issue4344
branch
from
2772e33 to
c9a481d
Compare
added 2 commits
December 11, 2020 16:33
Jolg42
added a commit
that referenced
this pull request
Dec 28, 2020
* master: fix(deps): update engines to v2.14.0-26.59cf08bf47e90cb37532900059f3328b4328237c (#4774) chore(deps): update definitelytyped fix(client): raw transactions (#4759) fix(deps): update engines to v2.14.0-22.85cf7930a5fc63cd99fa483153fd33cb35d49cfa chore(deps): update studio to v0.332.0 fix(client): improve error links (#4753) fix(deps): update engines to v2.14.0-21.aed47bccd0e3bc61e2a26b14315e2dd839d35a12 chore: bump engines (#4749) fix: fail early for known errors (#4734) chore: cleanup (#4707) fix(debug): allow multiple instances (#4665) chore: wip debug vercel (#4705) fix(deps): update engines to v2.14.0-17.af950b3705ef175e85492660c621085eb7f99557 chore(deps): update dependency rollup-plugin-dts to v2 (#4323) feat(client): add more jsdoc to Prisma Client (#4388) fix(deps): update engines to v2.14.0-16.c033861e8ed093701af214a25e2bb3e03edacf7c # Conflicts: # package.json # pnpm-lock.yaml # src/packages/client/package.json # src/packages/client/src/runtime/getPrismaClient.ts # src/packages/debug/package.json # src/packages/engine-core/package.json # src/packages/generator-helper/package.json # src/packages/get-platform/package.json # src/pnpm-lock.yaml
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
closes #4344