Global

Logs a deprecation warning for the decorated class method whenever it is called

Property decorator that will automatically assign the Logger singleton instance to the decorated class property

Example:

class Foo {
    @logger private readonly logger: Logger;
    ...

Note: This is a Typescript feature. If using the logger is desired in Javascript you should simply retrieve the singleton instance via Logger.instance()

Object containing options for controlling how command arguments will be parsed

Enum containing all base framework localization string keys

Object containing required Command properties to be passed to a Command on construction

The default settings to apply to new guilds. Stored under the key 'defaultGuildSettings' in Client#storage

Represents a difference between two given valid Unix time signatures

Valid arg type values for expect. Can be one of the following string literals:

'String' | 'Number' | 'User' | 'Member' | 'Role' | 'Channel' | 'Any'

or an Array of possible string literal values if specific string options are desired

Represents an object containing localization overrides for a command's desc, info, and usage fields

Represents an object passed from Logger to any TransportFunctions given to it

Enum containing the different levels of potential logger output. Each level represents itself and everything above it in the enum. The default logger log level is LogLevel.LOG

enum LogLevel
{
    NONE,
    LOG,
    INFO,
    WARN,
    ERROR.
    DEBUG
}

A function that takes a Message object and an array of args, does anything with them, and returns a Tuple where the first item is the Message object and the second item is the array of args

(Message, any[]) => [Message, any[]]

Can be async as long as the returned promise resolves with the tuple containing the message object and the args array as expected.

If a middleware function returns a string, or throws a string/error, it will be sent to the calling channel as a message and the Command execution will be aborted. If a middleware function does not return anything or returns something other than an array or string, the Command will fail silently.

Note: The command dispatcher will attempt to bind the Command instance to the middleware function when called, so this within a middleware function (if it is not an arrow function) will be the Command instance at runtime

Any class that extends and implements Plugin. Not to be confused with an instance of a Plugin.

Valid arg type values for resolve. Can be one of the following string literals:

'String' | 'Number' | 'Duration' | 'User' | 'Member' | 'BannedUser' | 'Channel' | 'Role'

Represents a function assigned to a specific language that takes a string key and an optional TemplateData object and returns a localized string for that language if it exists

Any class that extends and implements StorageProvider and provides an interface with a storage medium allowing data to be stored, retrieved, and manipulated. Not to be confused with an instance of a storage provider.

Represents an object mapping template keys to string values, where the template keys will be replaced with the provided values in the source string when given to a Lang resource function like Lang.res()

Represents a transport object for the Logger.

Represents a function to be given to Logger#addTransport that will receive log data. What is done with that log data is up to you, but logging to a file or a database would be some examples

Represents an array of fixed length where the the item in the specified position is of the specified type.

Example:

['foo', 10] === [string, number] === Tuple<string, number>

Object containing required Client properties to be passed to a Client on construction