@sapphire/plugin-api
Namespaces
| Namespace | Description |
|---|---|
| MediaParser | - |
| Middleware | - |
| Route | - |
Enumerations
| Enumeration | Description |
|---|---|
| HttpCodes | - |
| MimeTypes | - |
| ServerEvent | - |
Classes
| Class | Description |
|---|---|
| ApiRequest | - |
| ApiResponse | - |
| Auth | - |
| CookieStore | - |
| MediaParser | A media parser |
| MediaParserStore | - |
| Middleware | - |
| MiddlewareStore | - |
| Route | - |
| RouteStore | - |
| RouterBranch | - |
| RouterNode | - |
| RouterRoot | - |
| Server | - |
Interfaces
| Interface | Description |
|---|---|
| AuthData | Defines the authentication data, this is to be encrypted and decrypted by the server. |
| LoginData | The login data sent when fetching data from a user. |
| LoginDataTransformer | Transforms the object by mutating its properties or adding new ones. |
| MiddlewareOptions | The options for all middlewares. |
| RouteOptions | - |
| SecureCookieStoreSetOptions | - |
| ServerEvents | - |
| ServerOptions | The API options. |
| ServerOptionsAuth | Defines the authentication options. |
Type Aliases
| Type alias | Description |
|---|---|
| AuthLessServerOptions | The ServerOptions without ServerOptions.auth. |
| ContentTypeParameter | RFC 1341 4: Defines a Content-Type's parameter, which follows the following structure: |
| ContentTypeType | RFC 1341 4: Defines a Content-Type's type, which follows the following structure: |
| MethodName | - |
| MimeType | RFC 1341 4: Defines the syntax for a Content-Type field, which follows the following structure: type "/" subtype *[";" parameter]. |
| MimeTypeWithoutParameters | RFC 1341 4: Defines the syntax for a Content-Type field without parameters, which follows the following structure: type "/" subtype. |
Variables
| Variable | Description |
|---|---|
| MethodNames | - |
| version | The @sapphire/plugin-api version that you are currently using. An example use of this is showing it of in a bot information command. |
Functions
| Function | Description |
|---|---|
| loadListeners | - |
| loadMediaParsers | - |
| loadMiddlewares | - |
| loadRoutes | - |