API reference

Generated from the source with TypeDoc — every exported symbol, with its signature and TSDoc.

• @btravstack/entity — Entity, the merged Entity namespace, and the six type names (BaseInstance, ConstructionKey, EntityStatic, EntityUnion, Sealed, UnionMember) the published declarations force out.

Looking for prose?

The generated pages document signatures. For what each member is for, with worked examples, read the hand-written Reference; for why the surface is shaped this way, read the Explanation.

The shape of the surface

index.ts exports exactly one name you write against:

import { Entity } from "@btravstack/entity";

Entity.computed, Entity.invariant, Entity.union, Entity.InvalidEntity, Entity.keysOf and Entity.renderIssue hang off it as values, and every public type lives in a merged declare namespace Entity. A bare computed or union would be too generic to take from a consumer's import scope, so nothing else is exported — with one measured exception, the six declaration-emit type names a consumer's own .d.ts has to be able to write.