Home Reference Source

References

client

summary
public

The Ghastly client.

public

client/dispatcher

summary
public

One of the types that a prefix filter can be generated from.

public
public
public
public

client/services

summary
public

Manages services in the application.

command

summary
public

Groups commands.

public

Class which wraps a command handler with additional useful data.

public

Class handling storage and access control for commands.

public

The configuration object returned by command configurators.

command/parsers

summary
public
public

One of the types that a command parameter is allowed to take.

command/responses

summary
public

Wrapper for arbitrary voice responses.

public

Wrapper for broadcast voice responses.

public

Wrapper for converted stream voice responses.

public

Wrapper for file voice responses.

public

Wrapper for Opus voice responses.

public

Wrapper for custom message responses.

public

Wrapper for stream voice responses.

public

Wrapper for voice channel audio responses.

public

The type of method to use when sending audio responses.

public
public
public

core

summary
public

F configure(configuration: Object): Function

Provides a bridge to provide configuration data for command configurators.

errors

summary
public

Thrown when an error is encountered while parsing user arguments for a command.

public

Generic error for things related to commands.

public

Thrown when an error is encountered while parsing a message for a command.

public

Thrown when encountering an error parsing command parameters.

middleware

summary
public

F expectDM(): middlewareLayer

Middleware which filters out messages not received in a DM context.

public

F expectGroupDM(): middlewareLayer

Middleware which filters out messages not received in a group DM context.

public

F expectGuild(): middlewareLayer

Middleware which filters out messages not received in a guild context.

public

F expectPermissions(permissions: ...PermissionResolvable): middlewareLayer

Middleware which filters out messages based on user permissions.

public

F expectRole(identifiers: ...string): middlewareLayer

Middleware which filters out messages based on user role IDs or names.

public

F expectUser(identifiers: ...string): middlewareLayer

Middleware which filters out messages based on user IDs or usernames and discriminators.

public

utils

summary
public

Utility class with methods for adding Markdown syntax to text.