registryComponent

registryComponent<TValue, TId, TValueKey>(name, options): ComponentDef<RegistryComponentValue<TValue, TValueKey>>

Defined in: src/component-store.ts:560

Build a ComponentDef for registry-backed references.

The generated serializer stores only an id field (default: { id }), and deserializer resolves that id through a supplied lookup function, returning a single-field object (default: { def }).

Type Parameters

TValue

TValue

TId

TId extends string | number

TValueKey

TValueKey extends string = "def"

Parameters

name

string

options

RegistryComponentOptions<TValue, TId, TValueKey>

Returns

ComponentDef<RegistryComponentValue<TValue, TValueKey>>

Example

interface Card { def: CardDef }
const CardDefComp = registryComponent<CardDef, string>('card', {
  lookup: getCardDef,
  selectId: def => def.id,
});