Skip to main content

Interface: MiddlewareOptions

@sapphire/plugin-api.MiddlewareOptions

The options for all middlewares.

Hierarchy

  • Options

    โ†ณ MiddlewareOptions

Properties

enabled

โ€ข Optional Readonly enabled: boolean

Whether or not the piece should be enabled. If set to false, the piece will be unloaded.

default true

Inherited from

Piece.Options.enabled

Defined in

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


name

โ€ข Optional Readonly name: string

The name for the piece.

default ''

Inherited from

Piece.Options.name

Defined in

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


position

โ€ข Optional position: number

The position to insert the middleware at.

see Middleware#position

default 1000

Defined in

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