Share via


MiddlewareSet class

Represents a set of middleware.

Constructors

MiddlewareSet((Middleware | MiddlewareHandler)[])

Initializes a new instance of the MiddlewareSet class.

Methods

onTurn(TurnContext, () => Promise<void>)

Handles the turn of the middleware.

run(TurnContext, () => Promise<void>)

Runs the middleware chain.

use((Middleware | MiddlewareHandler)[])

Adds middleware to the set.

Constructor Details

MiddlewareSet((Middleware | MiddlewareHandler)[])

Initializes a new instance of the MiddlewareSet class.

new MiddlewareSet(middlewares: (Middleware | MiddlewareHandler)[])

Parameters

middlewares

(Middleware | MiddlewareHandler)[]

The middleware handlers or middleware objects to use.

Method Details

onTurn(TurnContext, () => Promise<void>)

Handles the turn of the middleware.

function onTurn(context: TurnContext, next: () => Promise<void>): Promise<void>

Parameters

context
TurnContext

The turn context.

next

() => Promise<void>

The next function to call.

Returns

Promise<void>

A promise representing the asynchronous operation.

run(TurnContext, () => Promise<void>)

Runs the middleware chain.

function run(context: TurnContext, next: () => Promise<void>): Promise<void>

Parameters

context
TurnContext

The turn context.

next

() => Promise<void>

The next function to call.

Returns

Promise<void>

A promise representing the asynchronous operation.

use((Middleware | MiddlewareHandler)[])

Adds middleware to the set.

function use(middlewares: (Middleware | MiddlewareHandler)[]): MiddlewareSet

Parameters

middlewares

(Middleware | MiddlewareHandler)[]

The middleware handlers or middleware objects to add.

Returns

The current MiddlewareSet instance.