CacheSchemaShape

tagtree · /core·interface

Fully-resolved schema descriptor held at runtime; carries namespace, optional tenant and qualifier configs, and the entity declarations that drive key building and fanout expansion.

Properties

entities
E
Map of entity names to their parameter and parent declarations.
namespace
NS
Top-level dotted-path prefix applied to all tags produced by this schema; must not contain ``.``.
qualifier?
Optional qualifier axis config; when present, read tags gain a per-qualifier ``::key`` suffix.
tenant?
Optional tenant axis config; when present, all cache tags are scoped per tenant value.

Example

const schema: CacheSchemaShape = defineCache({ namespace: 'commerce', entities: {} }).schema;

ContractTestOptions runAdapterContract AdapterCtx CacheAdapter CacheInstance CacheKey CacheSchema EntityDecl

Sourceschema.ts:70Edit the JSDoc directly

On this page