Skip to main content

Class: Middleware

@sapphire/plugin-api.Middleware

since 1.0.0

Hierarchy

  • Piece

    โ†ณ Middleware

Constructors

constructor

โ€ข new Middleware(context, options?)

Parameters

NameType
contextPieceContext
optionsMiddlewareOptions

Overrides

Piece.constructor

Defined in

projects/plugins/packages/api/src/lib/structures/Middleware.ts:23

Properties

enabled

โ€ข enabled: boolean

Whether or not the piece is enabled.

Inherited from

Piece.enabled

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:447


location

โ€ข Readonly location: PieceLocation

The location metadata for the piece's file.

Inherited from

Piece.location

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:439


name

โ€ข Readonly name: string

The name of the piece.

Inherited from

Piece.name

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:443


options

โ€ข Readonly options: PieceOptions

The raw options passed to this {@link Piece}

Inherited from

Piece.options

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:451


position

โ€ข Readonly position: number

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

Defined in

projects/plugins/packages/api/src/lib/structures/Middleware.ts:21


store

โ€ข Readonly store: Store<Piece<PieceOptions>>

The store that contains the piece.

Inherited from

Piece.store

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:435

Accessors

container

โ€ข get container(): Container

A reference to the {@link Container} object for ease of use.

see container

Returns

Container

Inherited from

Piece.container

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:457

Methods

onLoad

โ–ธ onLoad(): unknown

Per-piece listener that is called when the piece is loaded into the store. Useful to set-up asynchronous initialization tasks.

Returns

unknown

Inherited from

Piece.onLoad

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:462


onUnload

โ–ธ onUnload(): unknown

Per-piece listener that is called when the piece is unloaded from the store. Useful to set-up clean-up tasks.

Returns

unknown

Inherited from

Piece.onUnload

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:467


reload

โ–ธ reload(): Promise<void>

Reloads the piece by loading the same path in the store.

Returns

Promise<void>

Inherited from

Piece.reload

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:475


run

โ–ธ Abstract run(request, response, route): unknown

The method to be overridden by other middlewares.

Parameters

NameTypeDescription
requestApiRequestThe client's request.
responseApiResponseThe server's response.
routenull | RouteThe route that matched this request, will be null if none matched.

Returns

unknown

Defined in

projects/plugins/packages/api/src/lib/structures/Middleware.ts:34


toJSON

โ–ธ toJSON(): PieceJSON

Defines the JSON.stringify behavior of this piece.

Returns

PieceJSON

Inherited from

Piece.toJSON

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:479


unload

โ–ธ unload(): Promise<void>

Unloads and disables the piece.

Returns

Promise<void>

Inherited from

Piece.unload

Defined in

node_modules/@sapphire/pieces/dist/index.d.ts:471