Skip to main content

Interface: RouteOptions

Extends

  • Options

Properties

acceptedContentMimeTypes?

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

The accepted content types for this route. If set to null, the route will accept any data.

Since

1.3.0

Default

this.context.server.options.acceptedContentMimeTypes ?? null

Source

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


maximumBodyLength?

optional maximumBodyLength: number

(RFC 7230 3.3.2) The maximum decimal number of octets.

Since

1.0.0

Default

this.context.server.options.maximumBodyLength ?? 1024 * 1024 * 50

Source

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


route?

optional route: string

The route the piece should represent.

Since

1.0.0

Default

''

Examples

'/users'
// request.params -> {}
'/guilds/:guild/members/:member/'
// request.params -> { guild: '...', member: '...' }

Source

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