Skip to content

ResourceRef

ResourceRef<TId> = { id: TId; key?: never; name?: never; } | { id?: never; key?: never; name: string; } | { id?: never; key: string; name?: never; }

Selects a resource by exactly one identifier. Operational methods accept a ResourceRef and resolve it internally to the canonical identifier the API expects before executing the operation.

Three variants — id (numeric), name (folder-scoped), or key (GUID). The ?: never markers reject supplying more than one at compile time.

Type Parameters

Type Parameter
TId