Skip to main content

@jewel998/state-machine - v0.0.5 / IMiddleware

Interface: IMiddleware<TContext, TState>

Type parameters​

NameType
TContextextends ContextConstraint
TStateextends StateIdentifier = StateIdentifier

Implemented by​

Table of contents​

Properties​

Methods​

Properties​

name​

• Readonly name: string

Defined in​

src/middleware/types.ts:67

priority​

• Readonly priority: number

Defined in​

src/middleware/types.ts:68

enabled​

• Readonly enabled: boolean

Defined in​

src/middleware/types.ts:69

Methods​

onGuard​

▸ onGuard(context, next, originalGuard?): boolean | Promise<boolean>

Parameters​

NameType
contextStateMachineMiddlewareContext<TContext>
next() => Promise<boolean>
originalGuard?GuardFunction<TContext>

Returns​

boolean | Promise<boolean>

Defined in​

src/middleware/types.ts:72

onAction​

▸ onAction(context, next, originalAction?): MiddlewareResult<TContext> | Promise<MiddlewareResult<TContext>>

Parameters​

NameType
contextStateMachineMiddlewareContext<TContext>
nextNextFunction<TContext>
originalAction?ActionFunction<TContext>

Returns​

MiddlewareResult<TContext> | Promise<MiddlewareResult<TContext>>

Defined in​

src/middleware/types.ts:78

onStateEntry​

▸ onStateEntry(context, next, state, originalAction?): MiddlewareResult<TContext> | Promise<MiddlewareResult<TContext>>

Parameters​

NameType
contextStateMachineMiddlewareContext<TContext>
nextNextFunction<TContext>
stateTState
originalAction?ActionFunction<TContext>

Returns​

MiddlewareResult<TContext> | Promise<MiddlewareResult<TContext>>

Defined in​

src/middleware/types.ts:84

onStateExit​

▸ onStateExit(context, next, state, originalAction?): MiddlewareResult<TContext> | Promise<MiddlewareResult<TContext>>

Parameters​

NameType
contextStateMachineMiddlewareContext<TContext>
nextNextFunction<TContext>
stateTState
originalAction?ActionFunction<TContext>

Returns​

MiddlewareResult<TContext> | Promise<MiddlewareResult<TContext>>

Defined in​

src/middleware/types.ts:91

onBeforePipeline​

▸ onBeforePipeline(context): void | Promise<void>

Parameters​

NameType
contextStateMachineMiddlewareContext<TContext>

Returns​

void | Promise<void>

Defined in​

src/middleware/types.ts:99

onAfterPipeline​

▸ onAfterPipeline(context, result): void | Promise<void>

Parameters​

NameType
contextStateMachineMiddlewareContext<TContext>
resultMiddlewareResult<TContext>

Returns​

void | Promise<void>

Defined in​

src/middleware/types.ts:102

onError​

▸ onError(error, context): void | Promise<void>

Parameters​

NameType
errorError
contextStateMachineMiddlewareContext<TContext>

Returns​

void | Promise<void>

Defined in​

src/middleware/types.ts:106