ghastly (master)

# constructor(options, options.prefix)

Constructor.

Parameters

# Ghastly()

# this.commands()

The command registry for the client.

# this.dispatcher()

private method

The client's dispatcher.

# this.services()

The client's service container.

# constructor(filter)

Constructor.

Parameters

# DeferredFilter()

Filters out messages based on the return value of a closure.

# test(message)

Tests a message and determines if it passes the filter.

Parameters

# constructor(options, options.client, options.prefix)

Constructor.

Parameters

# createPrefixFilter(prefix)

private method

Generates a prefix filter.

Parameters

# dispatch(message, newMessage)

Receives message update events and dispatches commands found in the messages.

Parameters

# Dispatcher()

# dispatchResponse(channel, response)

private method

Dispatches the given response value.

Parameters

# resolveResponseType(response)

private method

Resolves a given response value to a type.

Parameters

# RESPONSE_TYPES()

Response type strings.

# shouldFilterEvent(message, newMessage)

private method

Determines if a message event should be filtered from the handler.

Parameters

# shouldFilterPrefix(prefix, message)

private method

Determines if a message should be filtered from the handler based on the given prefix.

Parameters

# this.client()

The client this dispatcher is attached to.

# this.prefix()

private method

The raw prefix given as an option.

# this.prefixFilter()

private method

The prefix filter constructed from the raw prefix.

# constructor(filter)

Constructor.

Parameters

# PrefixFilter()

Filters out messages based on a prefix.

# test(message)

Tests a message and determines if it passes the filter.

Parameters

# this.filter()

The filter.

# constructor(filter)

Constructor.

Parameters

# RegexFilter()

Filters out messages based on a RegEx.

# test(message)

Tests a message and determines if it passes the filter.

Parameters

# ConstructedService()

# es(aliases, builder)

Constructor.

Parameters

# service()

The service.

# es(aliases, instance)

Constructor.

Parameters

# InstanceService()

# service()

The service.

# constructor(options, options.aliases, options.builder, options.instance)

Constructor.

Parameters

# Service()

# ServiceTypes()

Type identifier for services.

# this.aliases()

Aliases for this entry.

# this.builder()

The service builder. Only applicable to constructed and singleton services.

# this.instance()

The service instance. Only applicable to singleton and instance services.

# ...providers(providers)

Binds services to the service container via service providers.

Parameters

# addService(type, identifier, service)

private method

Adds a service to the container.

Parameters

# construct(identifier, builder)

Binds a service to the container which is rebuilt each time it is fetched.

Parameters

# constructor()

Constructor.

# get(identifier)

Fetches a service from the container, constructing it if necessary.

Parameters

# getMainBinding(alias)

private method

Returns the main bound identifier for an alias. If the alias is already a main bound identifier, that identifier is returned directly.

Parameters

# has(identifier)

Determines if an identifier has been bound in the container.

Parameters

# instance(identifier, value)

Binds a service to the container which is returned as a value each time it is fetched.

Parameters

# mainBindings()

Returns an iterator containing the main service bindings that have been registered.

# ServiceContainer()

# singleton(identifier, builder)

Binds a service to the container which is built once and cached for subsequent fetches.

Parameters

# this.aliases()

private method

The identifier aliases in this container.

# this.services()

private method

The services stored in this container.

# unbind(identifier)

Removes a binding from the container, along with its aliases.

Parameters

# es(aliases, builder)

Constructor.

Parameters

# service()

The service.

# SingletonService()

# this.instance()

# ...layers(layers)

Adds the given middleware to the current group middleware layers.

Parameters

# add(command)

Adds a command to the group.

Parameters

# CommandGroup()

# constructor(name)

Constructor.

Parameters

# this.commands()

private method

The commands that are a part of the group.

# this.middleware()

private method

The middleware applied to the group.

# this.name()

The name of the group.

# CommandObject()

# constructor(configuration)

Constructor.

Parameters

# generateHandler(handler, middleware)

private method

Applies middleware to a command handler and returns the resulting handler function.

Parameters

# handle(context)

Executes the command handler.

Parameters

# linkGroup(commandGroup)

Subscribes to updates from a command group.

Parameters

# this.aliases()

An array of aliases for the command.

# this.dependencies()

A mapping between service names and the context names they should be injected under for the command handler.

# this.description()

The description for the command.

# this.group()

The name of the group this command is part of, if any.

# this.handler()

private method

The command handler function with middleware applied to it.

# this.middleware()

private method

The middleware applied to the handler function.

# this.name()

The main trigger of the command, also acting as its name.

# this.originalHandler()

private method

The original command handler function.

# this.parameters()

An array of parameter definitions for the command.

# ...configurators(configurators)

Adds the given commands to the registry.

Parameters

# addCommand(command)

private method

Adds a command to the registry.

Parameters

# applyGroupMiddleware(group, middleware)

Applies middleware to a command group.

Parameters

# CommandRegistry()

# constructor()

Constructor.

# es(name, aliases)

private method

Adds command aliases to the registry.

Parameters

# get(identifier)

Gets a command from the registry.

Parameters

# getMainName(identifier)

private method

Returns the main name associated with an identifier.

Parameters

# this.aliases()

private method

The command aliases stored in this registry.

# this.commands()

private method

The commands stored in this registry.

# this.groups()

private method

The command groups stored in the registry.

# ArgumentParser()

# normalizeArgumentType(type, argument)

Converts an argument to the given type, ignoring string arguments.

Parameters

# parse(rules, args)

Parses an array of arguments for a command call.

Parameters

# CommandParser()

# parse(message, prefix)

Parses the given message for a command.

Parameters

# ...parameters(parameters)

Validates a set of parameters.

Parameters

# ...parameters(parameters)

Parses a set of parameters into ParsedParameter objects.

Parameters

# ParameterParser()

# parseDefinition(definition)

Parses the definition portion of a parameter string.

Parameters

# parseParameter(parameter)

Parses the given command parameter definition and returns an object containing data on it.

Parameters

# constructor(values, values.raw, values.trimmed, values.identifier, values.args, values.rawArgs)

Constructor.

Parameters

# ParsedCommand()

# this.args()

A space-delimited array of arguments that were given as part of the command.

# this.identifier()

The name of the command being invoked.

# this.raw()

The raw message content.

# this.rawArgs()

The delimited arguments joined together as a string.

# this.trimmed()

The raw message content with any command prefix trimmed from the start.

# constructor(values)

Constructor.

Parameters

# ParsedParameter()

# this.defaultValue()

The default value of the parameter. This is non-null only if the parameter is optional. The default value for a repeatable parameter will be an array of values while non-repeatable parameters store a single primitive as a default value. The types of these values are determined by the parameters's type declaration defaulting to strings.

# this.description()

A description of the parameter.

# this.literal()

Whether or no the parameter is a literal string, i.e. takes the value of the input as given. Can only be applied to string parameters.

# this.name()

The name of the parameter.

# this.optional()

Whether or not the parameter is optional.

# this.repeatable()

Whether or not the parameter accepts a variable number of input arguments.

# this.type()

The expected type of the parameter.

# BOOL()

Alias for Boolean type.

# BOOLEAN()

Boolean type.

# convertType(value, type)

Converts a string value to a given type.

Parameters

# INT()

Alias for Integer type.

# INTEGER()

Integer type.

# isType(value, expectedType)

Determines if a string value is of the expected type.

Parameters

# NUM()

Alias for Number type.

# NUMBER()

Number type.

# resolveType(value)

Resolves a string value to a type string.

Parameters

# STR()

Alias for String type.

# STRING()

String type.

# ArbitraryVoiceResponse()

# constructor(context, input, options)

Constructor.

Parameters

# BroadcastVoiceResponse()

# t(context, broadcast, options)

Constructor.

Parameters

# constructor(context, stream, options)

Constructor.

Parameters

# ConvertedVoiceResponse()

# constructor(context, file, options)

Constructor.

Parameters

# FileVoiceResponse()

# constructor(context, stream, options)

Constructor.

Parameters

# OpusVoiceResponse()

# constructor(executor)

Constructor.

Parameters

# respond()

Executes the message response handler.

# Response()

# this.executor()

private method

The function handling the message response.

# constructor(context, stream, options)

Constructor.

Parameters

# StreamVoiceResponse()

# constructor(context, inputMethod, payload, options)

Constructor.

Parameters

# VoiceInputMethods()

Valid voice input methods.

# VoiceResponse()

# apply(middleware)

Takes a set of middleware functions and returns a function which consumes a single command handler function and produces a new handler function with the given middleware applied to it.

Parameters

# compose(functions)

Composes a set of functions into a chain of middleware. The last function acts as the innermost part of the middleware chain. For instance, compose(f, g) returns a function with contract (...args) => f(g, ...args).

Parameters

# configure(configuration)

Provides a bridge to provide configuration data for command configurators. Consumes a config object containing the configuration data and produces a function. This function consumes a configurator and returns another configurator with the given configuration applied to it. Several configure() calls can be made successively on the returned configurator, with the outer config objects overwriting the keys in the innermost configs.

Parameters

# DEFAULT_PROPERTIES()

Properties which are automatically handled when using object configurations.

# ArgumentParserError()

# CommandError()

# CommandParserError()

# ParameterParserError()

# expectDM()

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

# expectGroupDM()

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

# expectGuild()

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

# expectPermissions(permissions)

Middleware which filters out messages based on user permissions. Members must possess all of the given permissions to pass the filter. Only filters out messages if in a guild context.

Parameters

# expectRole(identifiers)

Middleware which filters out messages based on user role IDs or names. Only filters out messages if in a guild context.

Parameters

# expectUser(identifiers)

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

Parameters

# expectChannelType(type)

Middleware which filters out messages based on the channel type.

Parameters

# BaseResolver()

# constructor()

Constructor.

# resolve(options)

Validates the given options object and returns a promise.

Parameters

# this.resolver()

The resolver.

# CommandObjectResolver()

# constructor()

Constructor.

# constructor()

Constructor.

# ParameterResolver()

# createResolver()

Custom version of krachot/options-resolver that supports synchronous resolution.

# bold(text)

Formats a string as bold text.

Parameters

# code(text)

Formats a string as inline code.

Parameters

# codeBlock(text, syntax)

Formats a string as multi-line code.

Parameters

# italic(text)

Formats a string as italic text.

Parameters

# MarkdownFormatter()

# strikeout(text)

Formats a string as strikeout text.

Parameters

# underline(text)

Formats a string as underlined text.

Parameters

# constructor(iterable)

Constructor.

Parameters

# delete(key)

Removes a key from the map.

Parameters

# get(key)

Returns a value from the map.

Parameters

# has(key)

Checks if a key exists in the map.

Parameters

# set(key, value)

Sets a value in the map.

Parameters

# StringMap()