Abstract Class: Middleware<Options>

Defined in: packages/api/src/lib/structures/Middleware.ts:9

Since

1.0.0

Extends

• Piece<Options, "middlewares">

Type Parameters

Type Parameter	Default type
Options extends Options	Options

Constructors

Constructor

new Middleware<Options>(context: LoaderContext, options: Options): Middleware<Options>

Defined in: packages/api/src/lib/structures/Middleware.ts:22

Parameters

Parameter	Type
context	LoaderContext
options	Options

Returns

Middleware<Options>

Overrides

Piece<Options, 'middlewares'>.constructor

Properties

position

readonly position: number

Defined in: packages/api/src/lib/structures/Middleware.ts:20

The position the middleware has. The MiddlewareStore will run all middlewares with lower position than this one.

The built-in middlewares follow the following positions:

• headers: 10
• body: 20
• cookies: 30
• auth: 40

Methods

run()

abstract run(request: ApiRequest, response: Response): unknown

Defined in: packages/api/src/lib/structures/Middleware.ts:33

The method to be overridden by other middlewares.

Parameters

Parameter	Type	Description
request	ApiRequest	The client's request.
response	Response	The server's response.

Returns

unknown