Class: Route<Options>
@sapphire/plugin-api.Route
Since
1.0.0
Type parameters
| Name | Type |
|---|---|
Options | extends Options = Options |
Hierarchy
-
Piece<Options,"routes">↳
Route
Constructors
constructor
• new Route<Options>(context, options?): Route<Options>
Type parameters
| Name | Type |
|---|---|
Options | extends RouteOptions = RouteOptions |
Parameters
| Name | Type |
|---|---|
context | LoaderContext |
options | Options |
Returns
Route<Options>
Overrides
Piece<Options, 'routes'>.constructor
Defined in
projects/plugins/packages/api/src/lib/structures/Route.ts:33
Properties
acceptedContentMimeTypes
• Readonly acceptedContentMimeTypes: null | readonly (`message/${string}` | `audio/${string}` | `video/${string}` | `image/${string}` | `text/${string}` | `application/${string}` | `multipart/${string}` | `X-${string}/${string}`)[]
The accepted content types.
Defined in
projects/plugins/packages/api/src/lib/structures/Route.ts:21
enabled
• enabled: boolean
Whether or not the piece is enabled.
Inherited from
Piece.enabled
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:234
location
• Readonly location: PieceLocation
The location metadata for the piece's file.
Inherited from
Piece.location
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:226
maximumBodyLength
• Readonly maximumBodyLength: number
(RFC 7230 3.3.2) The maximum decimal number of octets.
Defined in
projects/plugins/packages/api/src/lib/structures/Route.ts:16
methods
• Readonly methods: Collection<Methods, MethodCallback>
The methods this route accepts.
Defined in
projects/plugins/packages/api/src/lib/structures/Route.ts:31
name
• Readonly name: string
The name of the piece.
Inherited from
Piece.name
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:230
options
• Readonly options: Options
The raw options passed to this Piece
Inherited from
Piece.options
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:238
router
• Readonly router: RouteData
The route information.
Defined in
projects/plugins/packages/api/src/lib/structures/Route.ts:26
store
• Readonly store: RouteStore
The store that contains the piece.
Inherited from
Piece.store
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:222
Accessors
container
• get container(): Container
A reference to the Container object for ease of use.
Returns
Container
See
container
Inherited from
Piece.container
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:244
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
Overrides
Piece.onLoad
Defined in
projects/plugins/packages/api/src/lib/structures/Route.ts:52
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
Overrides
Piece.onUnload
Defined in
projects/plugins/packages/api/src/lib/structures/Route.ts:66
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/esm/index.d.mts:262
toJSON
▸ toJSON(): PieceJSON
Defines the JSON.stringify behavior of this piece.
Returns
PieceJSON
Inherited from
Piece.toJSON
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:266
unload
▸ unload(): Promise<void>
Unloads and disables the piece.
Returns
Promise<void>
Inherited from
Piece.unload
Defined in
node_modules/@sapphire/pieces/dist/esm/index.d.mts:258