GetServerArgs

Defined in: packages/core/src/api/get/server.ts:22

Server-side args for get.

Inherits ctx, populate, depth, and config (with mutual-exclusion constraints) from GenericQueryServerParams.

Extends

• GenericQueryServerParams<DataModel, TCollectionSlug, TPopulate, D>

Type Parameters

DataModel

DataModel extends GenericDataModel

The Convex data model (inferred from ctx).

TCollectionSlug

TCollectionSlug extends CollectionSlug

Collection slug.

TPopulate

TPopulate extends PopulateShape<TCollectionSlug>

Populate object.

D

D extends number = 0

Depth literal (0 = no depth, default).

Properties

access?

optional access?: AccessCallOptions<QueryCallAction>

Defined in: packages/core/src/api/types.ts:216

Per-call access overrides.

See

AccessCallOptions

Inherited from

GenericQueryServerParams.access

---

auth?

optional auth?: VexApiAuth

Defined in: packages/core/src/api/types.ts:223

The auth config of the current user making the query.

Example

{ user: {...}, organization: {...} }

Inherited from

GenericQueryServerParams.auth

---

collection

collection: TCollectionSlug

Defined in: packages/core/src/api/get/server.ts:31

The collection slug to patch this document.

---

config?

optional config?: [TPopulate] extends [Record<string, never>] ? VexConfig : never

Defined in: packages/core/src/api/types.ts:241

The resolved VexConfig. Required alongside depth; passed from the queryApi factory closure so the Convex handler has schema info.

Inherited from

GenericQueryServerParams.config

---

ctx

ctx: GenericQueryCtx<DataModel>

Defined in: packages/core/src/api/types.ts:225

Discriminator: server args MUST supply a Convex query context.

Inherited from

GenericQueryServerParams.ctx

---

depth?

optional depth?: [TPopulate] extends [Record<string, never>] ? D : never

Defined in: packages/core/src/api/types.ts:236

Auto-populate all relationship fields to this many levels. Becomes never when TPopulate is non-empty. Use populate for consumer-facing code; this is an internal escape hatch for CollectionListView.

Inherited from

GenericQueryServerParams.depth

---

id

id: Id<TCollectionSlug>

Defined in: packages/core/src/api/get/server.ts:29

The document ID to fetch.

---

populate?

optional populate?: [D] extends [0] ? TPopulate : never

Defined in: packages/core/src/api/types.ts:230

Recursive populate object, type-narrowed against RelationshipKeysOf<TCollectionSlug>. Mutually exclusive with depth — becomes never when D ≠ 0.

Inherited from

GenericQueryServerParams.populate