Documentation

Documentation / @zerotal/orm / index / StateGuard

Type Alias: StateGuard<T>

StateGuard<T> = (model, ctx) => boolean | void | Promise<boolean | void>

Defined in: packages/orm/src/model/State.ts:55

A guard that runs before a transition is committed. It may:

• allow it (return true/undefined),
• block it (return false — yields a generic StateError), or
• reject it with a reason via ctx.reject(reason) (a StateError carrying that reason).

Type Parameters

T

T

Parameters

model

T

ctx

TransitionContext

Returns

boolean | void | Promise<boolean | void>