feat(client): add more jsdoc to Prisma Client

[williamluke4]

closes #4344

• Aggregate{Model}Args
  • where
  • orderBy
  • cursor
  • take
  • skip
  • count
  • avg
  • sum
  • min
  • max
• FindFirst{Model}Args
  • orderBy
  • cursor
  • take
  • skip
  • distinct
• {Model}UpdateManyArgs
  • data
  • where
• DeleteManyArgs
  • where
• {Model}Delegate.count()
• {Model}Delegate.aggregate()

[timsuchanek]

Could you build that into InputField?

[williamluke4]

I would have done that but it would take a while to implement

[timsuchanek]

Where did the conditions go?

[williamluke4]

into getArgs

[Jolg42]

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 */,
    },
  },
})

[williamluke4]

Takes n Posts from the position of the cursor, including the cursor?

[Jolg42]

Takes n Posts from the position of the cursor, cursor included. maybe

[williamluke4]

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\`.

[Jolg42]

So the cursor is always included from what I understand.
This suggests the cursor is included only in one case