Class: Middleware
api/src.Middleware
Hierarchy
Piece↳
Middleware
Constructors
constructor
• new Middleware(context, options?)
Parameters
| Name | Type |
|---|---|
context | PieceContext |
options | MiddlewareOptions |
Overrides
Piece.constructor
Defined in
projects/plugins/packages/api/src/lib/structures/Middleware.ts:23
Properties
enabled
• enabled: boolean
Inherited from
Piece.enabled
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:447
location
• Readonly location: PieceLocation
Inherited from
Piece.location
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:439
name
• Readonly name: string
Inherited from
Piece.name
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:443
options
• Readonly options: PieceOptions
Inherited from
Piece.options
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:451
position
• Readonly position: number
Defined in
projects/plugins/packages/api/src/lib/structures/Middleware.ts:21
store
• Readonly store: Store<Piece<PieceOptions>>
Inherited from
Piece.store
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:435
Accessors
container
• get container(): Container
Returns
Container
Inherited from
Piece.container
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:457
Methods
onLoad
▸ onLoad(): unknown
Returns
unknown
Inherited from
Piece.onLoad
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:462
onUnload
▸ onUnload(): unknown
Returns
unknown
Inherited from
Piece.onUnload
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:467
reload
▸ reload(): Promise<void>
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
Parameters
| Name | Type | Description |
|---|---|---|
request | ApiRequest | |
response | ApiResponse | |
route | null | Route |
Returns
unknown
Defined in
projects/plugins/packages/api/src/lib/structures/Middleware.ts:34
toJSON
▸ toJSON(): PieceJSON
Returns
PieceJSON
Inherited from
Piece.toJSON
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:479
unload
▸ unload(): Promise<void>
Returns
Promise<void>
Inherited from
Piece.unload
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:471