Skip to main content

Class: Route

api/src.Route

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 (`message/${string}` | `application/${string}` | `text/${string}` | `multipart/${string}` | `image/${string}` | `audio/${string}` | `video/${string}` | `X-${string}/${string}`)[]

Defined in

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


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


maximumBodyLength

Readonly maximumBodyLength: number

Defined in

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


methods

Readonly methods: Collection<Methods, MethodCallback>

Defined in

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


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


router

Readonly router: RouteData

Defined in

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


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

Overrides

Piece.onLoad

Defined in

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


onUnload

onUnload(): unknown

Returns

unknown

Overrides

Piece.onUnload

Defined in

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


reload

reload(): Promise<void>

Returns

Promise<void>

Inherited from

Piece.reload

Defined in

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


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