Skip to main content

Interface: Family()<TInput, TNode>

Defined in: packages/core/src/family.ts:95

The callable a family returns: call it to get (or reuse) a member. Callable + namespaced, like the provider factories (openai, anthropic).

Type Parameters​

TInput​

TInput

TNode​

TNode

Family(input): TNode

Defined in: packages/core/src/family.ts:96

The callable a family returns: call it to get (or reuse) a member. Callable + namespaced, like the provider factories (openai, anthropic).

Parameters​

input​

TInput

Returns​

TNode

Properties​

familyId​

readonly familyId: string

Defined in: packages/core/src/family.ts:98

The stable id the registry and family-wide overrides key on.

Methods​

clear()​

clear(): void

Defined in: packages/core/src/family.ts:116

Drop all memoized members. The next call rebuilds.

Returns​

void


getGroupId()​

getGroupId(): string

Defined in: packages/core/src/family.ts:125

DeclaredGroup — how the dev panel lists a family that has built nothing.

Aliases of familyId and keys(), present as their own names because the registry asks every kind of declaration the same three questions and a crew answers them too. Cheap enough to leave ungated: they expose nothing the two members above do not, and only registration is dev-mode gated.

Returns​

string


getGroupKind()​

getGroupKind(): string

Defined in: packages/core/src/family.ts:126

Returns​

string


getMemberKeys()​

getMemberKeys(): string[]

Defined in: packages/core/src/family.ts:127

Returns​

string[]


keys()​

keys(): string[]

Defined in: packages/core/src/family.ts:107

Member keys built so far, oldest first — i.e. in the order max would evict them.

That is insertion order for an unbounded family, and least-recently-used order once max is set, because a hit on a bounded family re-inserts to keep recency honest.

Returns​

string[]


peek()​

peek(input): TNode | undefined

Defined in: packages/core/src/family.ts:114

The already-built member for this input, or undefined.

Total by construction: it never builds, and it never throws — an input the key derivation refuses is simply not present.

Parameters​

input​

TInput

Returns​

TNode | undefined