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

Class: MiddlewareManager<TContext, TState>

Type parameters

Name	Type
TContext	extends ContextConstraint
TState	extends StateIdentifier

Implements

• IMiddlewareManager<TContext, TState>

Table of contents

Constructors

• constructor

Methods

• addMiddleware
• removeMiddleware
• hasMiddleware
• getMiddleware
• getPipelineOrder
• clearPipeline
• executeGuardPipeline
• executeActionPipeline
• executeEntryPipeline
• executeExitPipeline
• executeGuardChain
• executeActionChain
• executeEntryChain
• executeExitChain
• getChainOrder
• clearChain
• executeGuardMiddleware
• executeActionMiddleware
• executeEntryMiddleware
• executeExitMiddleware

Constructors

constructor

• new MiddlewareManager<TContext, TState>(): MiddlewareManager<TContext, TState>

Type parameters

Name	Type
TContext	extends ContextConstraint
TState	extends StateIdentifier

Returns

MiddlewareManager<TContext, TState>

Methods

addMiddleware

▸ addMiddleware(middleware): void

Parameters

Name	Type
middleware	AnyMiddleware<TContext, TState>

Returns

void

Implementation of

IMiddlewareManager.addMiddleware

Defined in

src/middleware/MiddlewareManager.ts:36

---

removeMiddleware

▸ removeMiddleware(name): void

Parameters

Name	Type
name	string

Returns

void

Implementation of

IMiddlewareManager.removeMiddleware

Defined in

src/middleware/MiddlewareManager.ts:51

---

hasMiddleware

▸ hasMiddleware(name): boolean

Parameters

Name	Type
name	string

Returns

boolean

Implementation of

IMiddlewareManager.hasMiddleware

Defined in

src/middleware/MiddlewareManager.ts:59

---

getMiddleware

▸ getMiddleware(name): undefined | AnyMiddleware<TContext, TState>

Parameters

Name	Type
name	string

Returns

undefined | AnyMiddleware<TContext, TState>

Implementation of

IMiddlewareManager.getMiddleware

Defined in

src/middleware/MiddlewareManager.ts:63

---

getPipelineOrder

▸ getPipelineOrder(): string[]

Returns

string[]

Implementation of

IMiddlewareManager.getPipelineOrder

Defined in

src/middleware/MiddlewareManager.ts:69

---

clearPipeline

▸ clearPipeline(): void

Returns

void

Implementation of

IMiddlewareManager.clearPipeline

Defined in

src/middleware/MiddlewareManager.ts:77

---

executeGuardPipeline

▸ executeGuardPipeline(context, originalGuard?): Promise<boolean>

Parameters

Name	Type
context	TContext
originalGuard?	GuardFunction<TContext>

Returns

Promise<boolean>

Implementation of

IMiddlewareManager.executeGuardPipeline

Defined in

src/middleware/MiddlewareManager.ts:83

---

executeActionPipeline

▸ executeActionPipeline(context, originalAction?): Promise<MiddlewareResult<TContext>>

Parameters

Name	Type
context	TContext
originalAction?	ActionFunction<TContext>

Returns

Promise<MiddlewareResult<TContext>>

Implementation of

IMiddlewareManager.executeActionPipeline

Defined in

src/middleware/MiddlewareManager.ts:195

---

executeEntryPipeline

▸ executeEntryPipeline(context, state, originalAction?): Promise<MiddlewareResult<TContext>>

Parameters

Name	Type
context	TContext
state	TState
originalAction?	ActionFunction<TContext>

Returns

Promise<MiddlewareResult<TContext>>

Implementation of

IMiddlewareManager.executeEntryPipeline

Defined in

src/middleware/MiddlewareManager.ts:324

---

executeExitPipeline

▸ executeExitPipeline(context, state, originalAction?): Promise<MiddlewareResult<TContext>>

Parameters

Name	Type
context	TContext
state	TState
originalAction?	ActionFunction<TContext>

Returns

Promise<MiddlewareResult<TContext>>

Implementation of

IMiddlewareManager.executeExitPipeline

Defined in

src/middleware/MiddlewareManager.ts:453

---

executeGuardChain

▸ executeGuardChain(context, originalGuard?): Promise<boolean>

Parameters

Name	Type
context	TContext
originalGuard?	GuardFunction<TContext>

Returns

Promise<boolean>

Implementation of

IMiddlewareManager.executeGuardChain

Defined in

src/middleware/MiddlewareManager.ts:583

---

executeActionChain

▸ executeActionChain(context, originalAction?): Promise<MiddlewareResult<TContext>>

Parameters

Name	Type
context	TContext
originalAction?	ActionFunction<TContext>

Returns

Promise<MiddlewareResult<TContext>>

Implementation of

IMiddlewareManager.executeActionChain

Defined in

src/middleware/MiddlewareManager.ts:590

---

executeEntryChain

▸ executeEntryChain(context, state, originalAction?): Promise<MiddlewareResult<TContext>>

Parameters

Name	Type
context	TContext
state	TState
originalAction?	ActionFunction<TContext>

Returns

Promise<MiddlewareResult<TContext>>

Implementation of

IMiddlewareManager.executeEntryChain

Defined in

src/middleware/MiddlewareManager.ts:597

---

executeExitChain

▸ executeExitChain(context, state, originalAction?): Promise<MiddlewareResult<TContext>>

Parameters

Name	Type
context	TContext
state	TState
originalAction?	ActionFunction<TContext>

Returns

Promise<MiddlewareResult<TContext>>

Implementation of

IMiddlewareManager.executeExitChain

Defined in

src/middleware/MiddlewareManager.ts:605

---

getChainOrder

▸ getChainOrder(): string[]

Returns

string[]

Implementation of

IMiddlewareManager.getChainOrder

Defined in

src/middleware/MiddlewareManager.ts:613

---

clearChain

▸ clearChain(): void

Returns

void

Implementation of

IMiddlewareManager.clearChain

Defined in

src/middleware/MiddlewareManager.ts:617

---

executeGuardMiddleware

▸ executeGuardMiddleware(context, originalGuard?): Promise<boolean>

Parameters

Name	Type
context	TContext
originalGuard?	GuardFunction<TContext>

Returns

Promise<boolean>

Implementation of

IMiddlewareManager.executeGuardMiddleware

Defined in

src/middleware/MiddlewareManager.ts:622

---

executeActionMiddleware

▸ executeActionMiddleware(context, originalAction?): Promise<MiddlewareResult<TContext>>

Parameters

Name	Type
context	TContext
originalAction?	ActionFunction<TContext>

Returns

Promise<MiddlewareResult<TContext>>

Implementation of

IMiddlewareManager.executeActionMiddleware

Defined in

src/middleware/MiddlewareManager.ts:629

---

executeEntryMiddleware

▸ executeEntryMiddleware(context, state, originalAction?): Promise<MiddlewareResult<TContext>>

Parameters

Name	Type
context	TContext
state	TState
originalAction?	ActionFunction<TContext>

Returns

Promise<MiddlewareResult<TContext>>

Implementation of

IMiddlewareManager.executeEntryMiddleware

Defined in

src/middleware/MiddlewareManager.ts:636

---

executeExitMiddleware

▸ executeExitMiddleware(context, state, originalAction?): Promise<MiddlewareResult<TContext>>

Parameters

Name	Type
context	TContext
state	TState
originalAction?	ActionFunction<TContext>

Returns

Promise<MiddlewareResult<TContext>>

Implementation of

IMiddlewareManager.executeExitMiddleware

Defined in

src/middleware/MiddlewareManager.ts:644