Class Middleware<Context>

Type Parameters

Constructors

constructor

Properties

disabled execute executedCount hooks lastExecutedResult lastExecutedRuntime lastExecutedTs runtimeAverage runtimeHighest runtimeLowest runtimeStandardDeviation runtimeTotal runtimeVariance default

Methods

calculateStandardDeviation calculateVariance resetRuntimeStatistics run updateRuntimeStatistics

Constructors

constructor

Properties

disabled

disabled: boolean

Is this middleware disabled?

execute

execute: MiddlewareRunFunction<Context>

The function to execute when this middleware is called

executedCount

executedCount: number = 0

The number of times this middleware has been executed

hooks

hooks: MiddlewareHooks<Context>

Hooks to execute before and after the middleware is executed

lastExecutedResult

lastExecutedResult: unknown = null

The last result of this middleware

lastExecutedRuntime

lastExecutedRuntime: null | number = null

The last runtime of this middleware in milliseconds

lastExecutedTs

lastExecutedTs: null | number = null

The last time this middleware was executed

runtimeAverage

runtimeAverage: null | number = null

The average runtime of this middleware

runtimeHighest

runtimeHighest: null | number = null

Highest runtime seen for this middleware

runtimeLowest

runtimeLowest: null | number = null

Lowest runtime seen for this middleware

runtimeStandardDeviation

runtimeStandardDeviation: null | number = null

Standard deviation of runtime for this middleware

runtimeTotal

runtimeTotal: number = 0

Total runtime of this middleware

runtimeVariance

runtimeVariance: null | number = null

Variance of runtime for this middleware

Static Readonly default

default: {
    disabled: boolean;
    execute: (() => void);
    hooks: {
        after: null;
        before: null;
        onError: null;
    };
} = ...

Type declaration

  • disabled: boolean
  • execute: (() => void)
      • (): void

      • Returns void

  • hooks: {
        after: null;
        before: null;
        onError: null;
    }
    • after: null
    • before: null
    • onError: null

Methods

calculateStandardDeviation

  • calculateStandardDeviation(): null | number

  • Calculates the standard deviation of the runtime for this middleware

    Returns null | number

    The standard deviation of the runtime for this middleware

calculateVariance

  • calculateVariance(): null | number

  • Calculates the variance of the runtime for this middleware

    Returns null | number

    The variance of the runtime for this middleware

resetRuntimeStatistics

run

updateRuntimeStatistics

  • updateRuntimeStatistics(runtime): void

  • Updates the runtime statistics for this middleware

    Parameters

    • runtime: number

    Returns void

Settings

Member Visibility

Theme

On This Page

constructordisabledexecuteexecutedCounthookslastExecutedResultlastExecutedRuntimelastExecutedTsruntimeAverageruntimeHighestruntimeLowestruntimeStandardDeviationruntimeTotalruntimeVariancedefaultcalculateStandardDeviationcalculateVarianceresetRuntimeStatisticsrunupdateRuntimeStatistics