Skip to main content

State

@rotorsoft/act-root

@rotorsoft/act-root / act/src / State

Type Alias: State<TState, TEvents, TActions, TName>

State<TState, TEvents, TActions, TName> = StateSchemas<TState, TEvents, TActions> & object

Defined in: libs/act/src/types/action.ts:345

The full state definition, including schemas, handlers, and optional invariants and snapshot logic.

Type Declaration​

given?​

optional given: GivenHandlers<TState, TActions>

init()​

init: () => Readonly<TState>

Returns​

Readonly<TState>

name​

name: TName

on​

on: ActionHandlers<TState, TEvents, TActions>

patch​

patch: PatchHandlers<TState, TEvents>

snap()?​

optional snap: (snapshot) => boolean

Parameters​

snapshot​

Snapshot<TState, TEvents>

Returns​

boolean

Type Parameters​

TState​

TState extends Schema

State schema.

TEvents​

TEvents extends Schemas

Event schemas.

TActions​

TActions extends Schemas

Action schemas.

TName​

TName extends string = string

State name literal.