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

Class: BaseMiddleware<TContext, TState>

Type parameters

Name	Type
TContext	extends ContextConstraint
TState	extends StateIdentifier = StateIdentifier

Implements

• IMiddleware<TContext, TState>

Table of contents

Constructors

• constructor

Properties

• name
• priority
• enabled

Methods

• onGuard
• onAction
• onStateEntry
• onStateExit
• onBeforePipeline
• onAfterPipeline
• onError

Constructors

constructor

• new BaseMiddleware<TContext, TState>(name, options?): BaseMiddleware<TContext, TState>

Type parameters

Name	Type
TContext	extends ContextConstraint
TState	extends StateIdentifier = StateIdentifier

Parameters

Name	Type
name	string
options	Object
options.priority?	number
options.enabled?	boolean

Returns

BaseMiddleware<TContext, TState>

Defined in

src/middleware/BaseMiddleware.ts:28

Properties

name

• Readonly name: string

Implementation of

IMiddleware.name

Defined in

src/middleware/BaseMiddleware.ts:24

---

priority

• Readonly priority: number

Implementation of

IMiddleware.priority

Defined in

src/middleware/BaseMiddleware.ts:25

---

enabled

• Readonly enabled: boolean

Implementation of

IMiddleware.enabled

Defined in

src/middleware/BaseMiddleware.ts:26

Methods

onGuard

▸ onGuard(_context, next, _originalGuard?): Promise<boolean>

Parameters

Name	Type
_context	StateMachineMiddlewareContext<TContext>
next	() => Promise<boolean>
_originalGuard?	GuardFunction<TContext>

Returns

Promise<boolean>

Implementation of

IMiddleware.onGuard

Defined in

src/middleware/BaseMiddleware.ts:41

---

onAction

▸ onAction(_context, next, _originalAction?): Promise<MiddlewareResult<TContext>>

Parameters

Name	Type
_context	StateMachineMiddlewareContext<TContext>
next	NextFunction<TContext>
_originalAction?	ActionFunction<TContext>

Returns

Promise<MiddlewareResult<TContext>>

Implementation of

IMiddleware.onAction

Defined in

src/middleware/BaseMiddleware.ts:49

---

onStateEntry

▸ onStateEntry(_context, next, _state, _originalAction?): Promise<MiddlewareResult<TContext>>

Parameters

Name	Type
_context	StateMachineMiddlewareContext<TContext>
next	NextFunction<TContext>
_state	TState
_originalAction?	ActionFunction<TContext>

Returns

Promise<MiddlewareResult<TContext>>

Implementation of

IMiddleware.onStateEntry

Defined in

src/middleware/BaseMiddleware.ts:57

---

onStateExit

▸ onStateExit(_context, next, _state, _originalAction?): Promise<MiddlewareResult<TContext>>

Parameters

Name	Type
_context	StateMachineMiddlewareContext<TContext>
next	NextFunction<TContext>
_state	TState
_originalAction?	ActionFunction<TContext>

Returns

Promise<MiddlewareResult<TContext>>

Implementation of

IMiddleware.onStateExit

Defined in

src/middleware/BaseMiddleware.ts:66

---

onBeforePipeline

▸ onBeforePipeline(_context): Promise<void>

Parameters

Name	Type
_context	StateMachineMiddlewareContext<TContext>

Returns

Promise<void>

Implementation of

IMiddleware.onBeforePipeline

Defined in

src/middleware/BaseMiddleware.ts:76

---

onAfterPipeline

▸ onAfterPipeline(_context, _result): Promise<void>

Parameters

Name	Type
_context	StateMachineMiddlewareContext<TContext>
_result	MiddlewareResult<TContext>

Returns

Promise<void>

Implementation of

IMiddleware.onAfterPipeline

Defined in

src/middleware/BaseMiddleware.ts:82

---

onError

▸ onError(error, _context): Promise<void>

Parameters

Name	Type
error	Error
_context	StateMachineMiddlewareContext<TContext>

Returns

Promise<void>

Implementation of

IMiddleware.onError

Defined in

src/middleware/BaseMiddleware.ts:89