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

Interface: IMiddlewareManager<TContext, TState>

Type parameters

Name	Type
TContext	extends ContextConstraint
TState	extends StateIdentifier

Implemented by

• MiddlewareManager

Table of contents

Methods

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

Methods

addMiddleware

▸ addMiddleware(middleware): void

Parameters

Name	Type
middleware	MiddlewareConfig<TContext, TState> | IMiddleware<TContext, TState>

Returns

void

Defined in

src/middleware/types.ts:132

---

removeMiddleware

▸ removeMiddleware(name): void

Parameters

Name	Type
name	string

Returns

void

Defined in

src/middleware/types.ts:137

---

hasMiddleware

▸ hasMiddleware(name): boolean

Parameters

Name	Type
name	string

Returns

boolean

Defined in

src/middleware/types.ts:138

---

getMiddleware

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

Parameters

Name	Type
name	string

Returns

undefined | MiddlewareConfig<TContext, TState> | IMiddleware<TContext, TState>

Defined in

src/middleware/types.ts:139

---

executeGuardPipeline

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

Parameters

Name	Type
context	TContext
originalGuard?	GuardFunction<TContext>

Returns

Promise<boolean>

Defined in

src/middleware/types.ts:147

---

executeActionPipeline

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

Parameters

Name	Type
context	TContext
originalAction?	ActionFunction<TContext>

Returns

Promise<MiddlewareResult<TContext>>

Defined in

src/middleware/types.ts:151

---

executeEntryPipeline

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

Parameters

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

Returns

Promise<MiddlewareResult<TContext>>

Defined in

src/middleware/types.ts:155

---

executeExitPipeline

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

Parameters

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

Returns

Promise<MiddlewareResult<TContext>>

Defined in

src/middleware/types.ts:160

---

executeGuardChain

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

Parameters

Name	Type
context	TContext
originalGuard?	GuardFunction<TContext>

Returns

Promise<boolean>

Defined in

src/middleware/types.ts:167

---

executeActionChain

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

Parameters

Name	Type
context	TContext
originalAction?	ActionFunction<TContext>

Returns

Promise<MiddlewareResult<TContext>>

Defined in

src/middleware/types.ts:171

---

executeEntryChain

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

Parameters

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

Returns

Promise<MiddlewareResult<TContext>>

Defined in

src/middleware/types.ts:175

---

executeExitChain

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

Parameters

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

Returns

Promise<MiddlewareResult<TContext>>

Defined in

src/middleware/types.ts:180

---

executeGuardMiddleware

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

Parameters

Name	Type
context	TContext
originalGuard?	GuardFunction<TContext>

Returns

Promise<boolean>

Defined in

src/middleware/types.ts:187

---

executeActionMiddleware

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

Parameters

Name	Type
context	TContext
originalAction?	ActionFunction<TContext>

Returns

Promise<MiddlewareResult<TContext>>

Defined in

src/middleware/types.ts:191

---

executeEntryMiddleware

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

Parameters

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

Returns

Promise<MiddlewareResult<TContext>>

Defined in

src/middleware/types.ts:195

---

executeExitMiddleware

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

Parameters

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

Returns

Promise<MiddlewareResult<TContext>>

Defined in

src/middleware/types.ts:200

---

getPipelineOrder

▸ getPipelineOrder(): string[]

Returns

string[]

Defined in

src/middleware/types.ts:207

---

clearPipeline

▸ clearPipeline(): void

Returns

void

Defined in

src/middleware/types.ts:208

---

getChainOrder

▸ getChainOrder(): string[]

Returns

string[]

Defined in

src/middleware/types.ts:210

---

clearChain

▸ clearChain(): void

Returns

void

Defined in

src/middleware/types.ts:211