Skip to main content

Module: @sapphire/plugin-api

Namespaces

Enumerations

Classes

Interfaces

Type aliases

AuthLessServerOptions

ฦฌ AuthLessServerOptions: Omit<ServerOptions, "auth">

The ServerOptions without ServerOptions.auth.

since 1.0.0

Defined in

projects/plugins/packages/api/src/lib/structures/http/Server.ts:228


ContentTypeParameter

ฦฌ ContentTypeParameter: `; ${string}=${string}`

RFC 1341 4: Defines a Content-Type's parameter, which follows the following structure:

  • parameter = attribute "=" value
  • attribute = token
  • value = token / quoted-string
  • token = 1*<any CHAR except SPACE, CTLs, or tspecials>
  • tspecials = ( | ) | < | > | @ | , | ; | : | \ | " | / | [ | ] | ? | . | =

note tspecials must be in quoted-string, to use within parameter values.

note The definition of tspecials is the same as the RFC 822 definition of specials with the addition of the three characters /, ?, and =.

since 1.3.0

Defined in

projects/plugins/packages/api/src/lib/structures/http/Server.ts:153


ContentTypeType

ฦฌ ContentTypeType: "text" | "multipart" | "message" | "image" | "audio" | "video" | "application" | `X-${string}`

RFC 1341 4: Defines a Content-Type's type, which follows the following structure:

  • type = text | multipart | message | image | audio | video | application | x-token
  • x-token = The two characters "X-" followed, with no intervening white space, by any token

since 1.3.0

Defined in

projects/plugins/packages/api/src/lib/structures/http/Server.ts:137


MatchData

ฦฌ MatchData: Record<string, string> | null

Defined in

projects/plugins/packages/api/src/lib/utils/RouteData.ts:18


Methods

ฦฌ Methods: "ACL" | "BIND" | "CHECKOUT" | "CONNECT" | "COPY" | "DELETE" | "GET" | "HEAD" | "LINK" | "LOCK" | "M-SEARCH" | "MERGE" | "MKACTIVITY" | "MKCALENDAR" | "MKCOL" | "MOVE" | "NOTIFY" | "OPTIONS" | "PATCH" | "POST" | "PRI" | "PROPFIND" | "PROPPATCH" | "PURGE" | "PUT" | "REBIND" | "REPORT" | "SEARCH" | "SOURCE" | "SUBSCRIBE" | "TRACE" | "UNBIND" | "UNLINK" | "UNLOCK" | "UNSUBSCRIBE"

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpMethods.ts:3


MimeType

ฦฌ MimeType: `${MimeTypeWithoutParameters}${"" | ContentTypeParameter}`

RFC 1341 4: Defines the syntax for a Content-Type field, which follows the following structure: type "/" subtype *[";" parameter].

since 1.3.0

Defined in

projects/plugins/packages/api/src/lib/structures/http/Server.ts:166


MimeTypeWithoutParameters

ฦฌ MimeTypeWithoutParameters: `${ContentTypeType}/${string}`

RFC 1341 4: Defines the syntax for a Content-Type field without parameters, which follows the following structure: type "/" subtype.

Defined in

projects/plugins/packages/api/src/lib/structures/http/Server.ts:159

Variables

methodEntries

โ€ข methodEntries: readonly [Methods, symbol][]

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpMethods.ts:41


methods

โ€ข methods: Record<Methods, symbol>

Defined in

projects/plugins/packages/api/src/lib/structures/http/HttpMethods.ts:40