Skip to main content

@sapphire/plugin-api

Namespaces

NamespaceDescription
MediaParser-
Middleware-
Route-

Enumerations

EnumerationDescription
HttpCodes-
MimeTypes-
ServerEvents-
TypeState-

Classes

ClassDescription
ApiRequest-
ApiResponse-
Auth-
CookieStore-
MediaParserA media parser
MediaParserStore-
Middleware-
MiddlewareStore-
Route-
RouteData-
RouteStore-
Server-

Interfaces

InterfaceDescription
AuthDataDefines the authentication data, this is to be encrypted and decrypted by the server.
LoginDataThe login data sent when fetching data from a user.
LoginDataTransformerTransforms the object by mutating its properties or adding new ones.
MethodCallback-
MiddlewareErrorContextThe context sent in the error events.
MiddlewareOptionsThe options for all middlewares.
ParsedPart-
RouteMatch-
RouteOptions-
SecureCookieStoreSetOptions-
ServerOptionsThe API options.
ServerOptionsAuthDefines the authentication options.

Type Aliases

Type aliasDescription
AuthLessServerOptionsThe ServerOptions without ServerOptions.auth.
ContentTypeParameterRFC 1341 4: Defines a Content-Type's parameter, which follows the following structure:
ContentTypeTypeRFC 1341 4: Defines a Content-Type's type, which follows the following structure:
MatchData-
Methods-
MimeTypeRFC 1341 4: Defines the syntax for a Content-Type field, which follows the following structure:
MimeTypeWithoutParametersRFC 1341 4: Defines the syntax for a Content-Type field without parameters, which follows the following structure:

Variables

VariableDescription
methodEntries-
methods-
versionThe @sapphire/plugin-api version that you are currently using.

Functions

FunctionDescription
loadListeners-
loadMediaParsers-
loadMiddlewares-
loadRoutes-