Class MiddlewareStack<Input, Output, Context>

constructor

• new MiddlewareStack<
      Input extends object = any,
      Output extends object = any,
      Context extends object = object,
  >(
      stack?: Middleware<Input, Output, Context>[],
  ): MiddlewareStack<Input, Output, Context>

  Type Parameters

  • Input extends object = any
  • Output extends object = any
  • Context extends object = object

  Parameters

  • stack: Middleware<Input, Output, Context>[] = []

  Returns MiddlewareStack<Input, Output, Context>

Readonlystack

height

• get height(): number

  Gives the number of entries of the stack.

  Returns number

  The height of the stack.

add

• add(middleware: Middleware<Input, Output, Context>): this

  Add a middleware to the stack.

  Parameters

  • middleware: Middleware<Input, Output, Context>

    A relative or absolute middleware to add to the stack.

  Returns this

  The reference to this instance.

addAbsolute

• addAbsolute(middleware: AbsoluteMiddleware<Input, Output, Context>): this

  Adds middleware to the stack according to its step and priority.

  Parameters

  • middleware: AbsoluteMiddleware<Input, Output, Context>

    An absolute middleware to add to the stack.

  Returns this

  A reference to this instance.

addRelative

• addRelative(middleware: RelativeMiddleware<Input, Output, Context>): this

  Adds middleware to the stack relative to the anchoring middleware. If the anchoring middleware does not exist, the middleware will be ignored during the sorting process.

  Parameters

  • middleware: RelativeMiddleware<Input, Output, Context>

    A relative middleware to add to the stack.

  Returns this

  A reference to this instance.

createAbsolute

• createAbsolute(
      fn:
          | MiddlewareFunction<Input, Output, Context>
          | AbsoluteMiddleware<Input, Output, Context>,
      options?: AbsoluteMiddlewareOptions,
  ): this

  Creates the middleware and adds it to the stack according to its step and priority.

  Parameters

  • fn:
        | MiddlewareFunction<Input, Output, Context>
        | AbsoluteMiddleware<Input, Output, Context>

    An absolute middleware function to add to the stack.

  • Optionaloptions: AbsoluteMiddlewareOptions

    Additional information to sort the absolute middleware in the correct position.

  Returns this

  A reference to this instance.

createRelative

• createRelative(
      fn:
          | MiddlewareFunction<Input, Output, Context>
          | RelativeMiddleware<Input, Output, Context>,
      options: RelativeMiddlewareOptions,
  ): this

  Creates the middleware and adds it to the stack relative to the anchoring middleware.

  Parameters

  • fn:
        | MiddlewareFunction<Input, Output, Context>
        | RelativeMiddleware<Input, Output, Context>

    A relative middleware function to add to the stack.

  • options: RelativeMiddlewareOptions

    Additional information to sort the relative middleware in the correct position.

  Returns this

  A reference to this instance.

has

• has(middleware: string | Middleware<Input, Output, Context>): boolean

  Verifies the existence of a particular middleware in the stack.

  Parameters

  • middleware: string | Middleware<Input, Output, Context>

    A middleware name.

  Returns boolean

  An indicator that the middleware has or has not been added to the stack.

merge

• merge(
      stack: Middleware<Input, Output, Context>[],
  ): MiddlewareStack<Input, Output, Context>

  Merge creates a new MiddlewareStack from the entries from this middleware stack and those given.

  Parameters

  • stack: Middleware<Input, Output, Context>[]

    A middleware stack to merge into the current stack.

  Returns MiddlewareStack<Input, Output, Context>

  A new middleware stack with the current and supplied middleware sorted in it.

remove

• remove(name: string): this

  Remove deletes a middleware from the stack and cache.

  Parameters

  • name: string

    The name of the middleware to remove.

  Returns this

  The reference to this instance.

removeByRef

• removeByRef(ref: MiddlewareFunction<Input, Output, Context>): this

  RemoveByRef deletes the middleware function(s) that have the same reference as the given function.

  Parameters

  • ref: MiddlewareFunction<Input, Output, Context>

    The middleware function to remove by reference.

  Returns this

  The reference to this instance.

removeByTag

• removeByTag(tag: string): this

  RemoveByTag deletes the middleware function(s) that have the given tag.

  Parameters

  • tag: string

    Indicates the middleware to remove by tag.

  Returns this

  The reference to this instance.

resolve

• resolve<I extends object, O extends object>(
      terminalware: Terminalware<I, O>,
      context: MiddlewareExecutionContext<Context>,
  ): InitializeHandler<I, O>

  Resolve enchains the middleware by binding the next and context parameters and exposing a handler to begin the call chain.

  Type Parameters

  • I extends object
  • O extends object

  Parameters

  • terminalware: Terminalware<I, O>

    The last middleware to be called in the chain.

  • context: MiddlewareExecutionContext<Context>

    A context for sharing data between middleware calls such as a common logger.

  Returns InitializeHandler<I, O>

  The first middleware to be called on the middleware stack.

use

• use(plugin: Pluggable<Input, Output, Context>): this

  Provides a pluggable interface for manipulating this middleware stack instance. It should be used when performing multiple operations on a class instance in a transaction-like manner.

  Parameters

  • plugin: Pluggable<Input, Output, Context>

    A synchronous function called in the context of this instantiated class.

  Returns this

  The reference to this instance.