GenericGlobalsQueryServerArgs
Defined in: packages/core/src/globals/api/types.ts:18
Base server-side args shared by every globals query function
(getGlobal, findGlobals). Each concrete function extends this with its
own inputs (e.g. slug, populate, depth).
The RBAC seam rides on auth + config: when config.access is set, the
function runs hasPermission for the global’s slug using auth.user /
auth.organization. Resolved server-side by the globalsApi factory via
resolveGetAuth(getAuth) — never supplied by the client.
Type Parameters
Section titled “Type Parameters”TDataModel
Section titled “TDataModel”TDataModel extends GenericDataModel
The project’s generated Convex data model.
TGlobalSlug
Section titled “TGlobalSlug”TGlobalSlug extends GlobalSlug = GlobalSlug
Properties
Section titled “Properties”access?
Section titled “access?”
optionalaccess?:AccessCallOptions<QueryCallAction>
Defined in: packages/core/src/globals/api/types.ts:38
Per-call access overrides.
optionalauth?:VexApiAuth
Defined in: packages/core/src/globals/api/types.ts:28
Resolved caller identity for permission checks — { user, organization? },
or omitted when access control is off. user may be null for an
unauthenticated caller (→ no roles → deny). Never a client argument;
the factory resolves it from ctx.auth per request.
config
Section titled “config”config:
VexConfig
Defined in: packages/core/src/globals/api/types.ts:36
The resolved VexConfig. Required — supplies config.access (the
permission matrix the guard enforces) and config.globals (used to
resolve the GlobalConfig for depth-populate and validation).
ctx:
GenericQueryCtx<TDataModel>
Defined in: packages/core/src/globals/api/types.ts:30
Convex query context (read-only DB access).