Skip to main content

Class: Route

@sapphire/plugin-api.Route

since 1.0.0

Hierarchy

  • Piece

    Route

Constructors

constructor

new Route(context, options?)

Parameters

NameType
contextPieceContext
optionsRouteOptions

Overrides

Piece.constructor

Defined in

projects/plugins/packages/api/src/lib/structures/Route.ts:33

Properties

acceptedContentMimeTypes

Readonly acceptedContentMimeTypes: null | readonly (`text/${string}` | `multipart/${string}` | `message/${string}` | `image/${string}` | `audio/${string}` | `video/${string}` | `application/${string}` | `X-${string}/${string}`)[]

The accepted content types.

Defined in

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


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


router

Readonly router: RouteData

The route information.

Defined in

projects/plugins/packages/api/src/lib/structures/Route.ts:26

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