Type Alias FynAppMiddleware

Enhanced middleware implementation interface

type FynAppMiddleware = {
    autoApplyScope?: ("all" | "fynapp" | "middleware")[];
    name: string;
    apply?(context: FynAppMiddlewareCallContext): void | Promise<void>;
    canOverrideExecution?(fynApp: FynApp, fynUnit: FynUnit): boolean;
    overrideExecute?(context: FynAppMiddlewareCallContext): Promise<void>;
    overrideInitialize?(
        context: FynAppMiddlewareCallContext,
    ): Promise<{ mode?: string; status: string }>;
    setup?(
        context: FynAppMiddlewareCallContext,
    ): Promise<void | { share?: any; status: string }>;
    shouldApply?(fynApp: FynApp): boolean;
}

Index

Properties

autoApplyScope? name

Methods

apply? canOverrideExecution? overrideExecute? overrideInitialize? setup? shouldApply?

Properties

`Optional`autoApplyScope

autoApplyScope?: ("all" | "fynapp" | "middleware")[]

Controls automatic application. Explicit useMiddleware() calls always work regardless of autoApplyScope

name

name: string

name of the middleware

Methods

`Optional`apply

apply?(context: FynAppMiddlewareCallContext): void | Promise<void>
apply the middleware to a fynapp with context
Parameters
- context: FynAppMiddlewareCallContext
Returns void | Promise<void>
- Defined in core/kernel/src/types.ts:250

`Optional`canOverrideExecution

canOverrideExecution?(fynApp: FynApp, fynUnit: FynUnit): boolean
Execution override capabilities
Parameters
- fynApp: FynApp
- fynUnit: FynUnit
Returns boolean
- Defined in core/kernel/src/types.ts:253

`Optional`overrideExecute

overrideExecute?(context: FynAppMiddlewareCallContext): Promise<void>
Parameters
- context: FynAppMiddlewareCallContext
Returns Promise<void>
- Defined in core/kernel/src/types.ts:255

`Optional`overrideInitialize

overrideInitialize?(
context: FynAppMiddlewareCallContext,
): Promise<{ mode?: string; status: string }>
Parameters
- context: FynAppMiddlewareCallContext
Returns Promise<{ mode?: string; status: string }>
- Defined in core/kernel/src/types.ts:254

`Optional`setup

setup?(
context: FynAppMiddlewareCallContext,
): Promise<void | { share?: any; status: string }>
one time setup for the middleware
Parameters
- context: FynAppMiddlewareCallContext
Returns Promise<void | { share?: any; status: string }>
- Defined in core/kernel/src/types.ts:248

`Optional`shouldApply

shouldApply?(fynApp: FynApp): boolean
Optional filter function to determine if this middleware should apply to a specific FynApp
Parameters
- fynApp: FynApp
Returns boolean
- Defined in core/kernel/src/types.ts:246