GetClientArgs
Defined in: packages/react/src/collections/api/get/client.ts:18
Client-side args for get. Extends GenericQueryClientParams
to inherit ctx?: never, populate?: TPopulate, and depth?: D.
Extends
Section titled “Extends”GenericQueryClientParams<TCollectionSlug,TPopulate,D>
Type Parameters
Section titled “Type Parameters”TCollectionSlug
Section titled “TCollectionSlug”TCollectionSlug extends CollectionSlug
Collection slug, recovered from the Id brand.
TPopulate
Section titled “TPopulate”TPopulate extends PopulateShape<TCollectionSlug>
Populate object.
D extends number = 0
Depth literal (0 = none). Inferred from depth.
Properties
Section titled “Properties”
optionalauth?:undefined
Defined in: packages/core/src/collections/api/types.ts:88
Discriminator: client args MUST NOT supply auth.
Inherited from
Section titled “Inherited from”collection
Section titled “collection”collection:
TCollectionSlug
Defined in: packages/react/src/collections/api/get/client.ts:24
optionalctx?:undefined
Defined in: packages/core/src/collections/api/types.ts:90
Discriminator: client args MUST NOT supply ctx.
Inherited from
Section titled “Inherited from”depth?
Section titled “depth?”
optionaldepth?:D
Defined in: packages/core/src/collections/api/types.ts:104
Auto-populate all relationship fields to this many levels.
Inferred as the literal D so a wrapper that threads D through to its
return type narrows accordingly (depth: 2 → depth-populated doc). A
non-literal number degrades to VexDocument via DepthPopulated’s
guard. D defaults to number, so wrappers that do not thread it keep the
plain passthrough they had before.
Use populate for documented consumer code; depth is internal.
Inherited from
Section titled “Inherited from”GenericQueryClientParams.depth
drafts?
Section titled “drafts?”
optionaldrafts?:boolean
Defined in: packages/core/src/collections/api/types.ts:116
When true on a versioned collection, includes the document’s draft
row alongside its published row — gated server-side on the readDrafts
action (Step 13). Ignored for a non-versioned collection.
Inherited from
Section titled “Inherited from”GenericQueryClientParams.drafts
id:
Id<TCollectionSlug>
Defined in: packages/react/src/collections/api/get/client.ts:23
populate?
Section titled “populate?”
optionalpopulate?:TPopulate
Defined in: packages/core/src/collections/api/types.ts:92
Recursive populate object, type-narrowed against RelationshipKeysOf<TCollectionSlug>.
Inherited from
Section titled “Inherited from”GenericQueryClientParams.populate
optionalskip?:boolean
Defined in: packages/core/src/collections/api/types.ts:110
When true, the wrapper passes convexQuery’s "skip" sentinel instead of
args, so the query is not issued. Use for conditional queries (e.g. an id
that is not known yet) without violating the Rules of Hooks.