Appearance

Documentation / @etherfold/processor-entities / EntityDeclaration

Type Alias: EntityDeclaration ​

EntityDeclaration = object

Defined in: packages/state-store/dist/types.d.ts:67

Re-exported so a processor author imports the whole authoring surface from one place. They are DEFINED in @etherfold/state-store, because they are what a store must understand, not what a processor invents.

Properties ​

fields ​

fields: Readonly<Record<string, FieldDeclaration>>

Defined in: packages/state-store/dist/types.d.ts:76

data fields, excluding the business key, and their storage class (or enum, or semantic type, ADR-0098)

id ​

id: string | readonly string[]

Defined in: packages/state-store/dist/types.d.ts:74

The BUSINESS key columns (e.g. ['id'], or several for a composite key). Not the version key: a single business key has many versions over time.

name ​

name: string

Defined in: packages/state-store/dist/types.d.ts:69

entity name, e.g. token

parent? ​

optional parent?: EntityRelation

Defined in: packages/state-store/dist/types.d.ts:81

The entity this one is a CHILD of, if any (ADR-0098). Optional: a declaration without it means exactly what it always meant.