Appearance

Documentation / @etherfold/processor-entities / EnumField

Type Alias: EnumField ​

EnumField = object

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

A field declared as a value SET over text (ADR-0098): {storage: 'text', enum: ['open', 'closed']}.

It is stored exactly as a text field is, on every backend, so it needs no DDL case and no per-backend query support. What it adds is a check at WRITE time, for the cost of a set lookup: a value outside the set is refused, naming the field and the allowed values (assertFieldValues). NULL is still a legal value, as it is for every field, because a whole-row write leaves an unlisted field NULL. Each value must be a legal GraphQL enum name, refused at declaration time otherwise, so the schema ADR-0099 builds maps them one to one.

Properties ​

enum ​

readonly enum: readonly string[]

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

storage ​

readonly storage: "text"

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