@sapphire/framework v5.2.1

Namespaces

Namespace	Description
AllFlowsPrecondition	-
ApplicationCommandRegistry	-
Argument	-
ArgumentError	-
AutocompleteCommand	-
ChatInputCommand	-
Command	-
ContextMenuCommand	-
CorePreconditions	-
InteractionHandler	-
Listener	-
MessageCommand	-
Precondition	-
PreconditionError	-
PreconditionResolvers	-
Resolvers	-
UserError	-

Enumerations

Enumeration	Description
BucketScope	The scope the cooldown applies to.
CommandOptionsRunTypeEnum	The allowed values for CommandOptions.runIn as an enum.
CommandPreConditions	The available command pre-conditions.
CooldownLevel	-
Identifiers	-
InteractionHandlerTypes	-
InternalRegistryAPIType	-
LogLevel	The logger levels for the ILogger.
PluginHook	-
PreconditionRunCondition	The condition for a PreconditionContainerArray.
PreconditionRunMode	The run mode for a PreconditionContainerArray.
RegisterBehavior	-

Classes

Class	Description
AllFlowsPrecondition	-
ApplicationCommandRegistry	-
Args	The argument parser to be used in Command.
Argument	The base argument class. This class is abstract and is to be extended by subclasses implementing the methods. In Sapphire's workflow, arguments are called when using Args's methods (usually used inside Commands by default).
ArgumentError	Errors thrown by the argument parser
ArgumentStore	-
ClientPermissionsPrecondition	Constructs a contextful permissions precondition requirement.
Command	-
CommandStore	Stores all Command pieces
InteractionHandler	-
InteractionHandlerStore	-
Listener	The base event class. This class is abstract and is to be extended by subclasses, which should implement the methods. In Sapphire's workflow, listeners are called when the emitter they listen on emits a new message with the same event name.
ListenerLoaderStrategy	-
ListenerStore	-
Logger	-
Plugin	-
PluginManager	-
Precondition	-
PreconditionContainerArray	An IPreconditionContainer that defines an array of multiple IPreconditionContainers.
PreconditionContainerSingle	An IPreconditionContainer which runs a single precondition from SapphireClient.preconditions.
PreconditionError	Errors thrown by preconditions
PreconditionStore	-
SapphireClient	The base Client extension that makes Sapphire work. When building a Discord bot with the framework, the developer must either use this class, or extend it.
UserError	The UserError class to be emitted in the pieces.
UserPermissionsPrecondition	Constructs a contextful permissions precondition requirement.

Interfaces

Interface	Description
ArgOptions	-
ArgType	-
ArgsJson	-
ArgsNextCallback	The value to be mapped.
ArgumentContext	-
ArgumentOptions	-
AutocompleteCommandContext	-
AutocompleteInteractionPayload	-
BooleanArgumentContext	The context for the 'boolean' argument.
ChatInputCommandAcceptedPayload	-
ChatInputCommandContext	-
ChatInputCommandDeniedPayload	-
ChatInputCommandErrorPayload	-
ChatInputCommandFinishPayload	-
ChatInputCommandRunPayload	-
ChatInputCommandSuccessPayload	-
ClientLoggerOptions	-
CommandDoesNotHaveChatInputCommandHandlerPayload	-
CommandDoesNotHaveContextMenuCommandHandlerPayload	-
CommandDoesNotHaveMessageCommandHandler	-
CommandJSON	-
CommandOptions	The Command options.
CommandSpecificRunIn	A more detailed structure for CommandOptions.runIn when you want to have a different runIn for each command type.
ContextMenuCommandAcceptedPayload	-
ContextMenuCommandContext	-
ContextMenuCommandDeniedPayload	-
ContextMenuCommandErrorPayload	-
ContextMenuCommandFinishPayload	-
ContextMenuCommandRunPayload	-
ContextMenuCommandSuccessPayload	-
CooldownOptions	-
DetailedDescriptionCommandObject	-
EmojiObject	-
EnumArgumentContext	The context for the 'enum' argument.
IArgument	-
IChatInputCommandPayload	-
IContextMenuCommandPayload	-
IInteractionHandlerPayload	-
ILogger	-
IMessageCommandPayload	-
IPieceError	-
IPreconditionCondition	Defines the condition for PreconditionContainerArrays to run.
IPreconditionContainer	An abstracted precondition container to be implemented by classes.
InteractionHandlerError	-
InteractionHandlerJSON	-
InteractionHandlerOptions	-
InteractionHandlerParseError	-
InteractionHandlerParseNone	-
InteractionHandlerParseSome	-
InteractionHandlerParseSuccess	-
ListenerErrorPayload	-
ListenerJSON	-
ListenerOptions	-
MemberArgumentContext	The context for the 'member' argument.
MessageCommandAcceptedPayload	-
MessageCommandContext	-
MessageCommandDeniedPayload	-
MessageCommandErrorPayload	-
MessageCommandFinishPayload	-
MessageCommandRunPayload	-
MessageCommandSuccessPayload	-
MessageCommandTypingErrorPayload	-
MessageResolverOptions	Options to resolve a message from a string, given a certain context.
PreChatInputCommandRunPayload	-
PreContextMenuCommandRunPayload	-
PreMessageCommandRunPayload	-
PreconditionArrayResolvableDetails	Defines the detailed options for the PreconditionContainerArray, where both the PreconditionRunMode and the entries can be defined.
PreconditionContext	-
PreconditionOptions	-
PreconditionSingleResolvableDetails	Defines the detailed options for the PreconditionContainerSingle, where both the PreconditionContext and the name of the precondition can be defined.
Preconditions	The registered preconditions and their contexts, if any. When registering new ones, it is recommended to use module augmentation so custom ones are registered.
RepeatArgOptions	-
RunInPreconditionCommandSpecificData	The specific data for the precondition types for the RunIn precondition, when the command specified the types for specific command types.
SapphireClientOptions	-
SapphirePluginAsyncHook	-
SapphirePluginHook	-
SapphirePluginHookEntry	-
SapphirePrefixHook	-
SimplePreconditionSingleResolvableDetails	Defines the simple options for the PreconditionContainerSingle, where only the name of the precondition can be defined.
UnknownChatInputCommandPayload	-
UnknownContextMenuCommandPayload	-
UnknownMessageCommandNamePayload	-
UnknownMessageCommandPayload	-

Type Aliases

Type alias	Description
ApplicationCommandRegistryRegisterOptions	-
ArgumentResult	Defines a synchronous result of an Argument, check Argument.AsyncResult for the asynchronous version.
ArrayResultType	-
AsyncArgumentResult	Defines an asynchronous result of an Argument, check Argument.Result for the synchronous version.
AsyncPluginHooks	-
AsyncPreconditionContainerReturn	Async-only version of PreconditionContainerReturn, to be used when the run method is async.
AsyncPreconditionResult	-
AutocompleteCommand	-
AwaitableArgumentResult	Defines a synchronous or asynchronous result of an Argument, check Argument.AsyncResult for the asynchronous version.
ChatInputCommand	-
CommandOptionsRunType	The allowed values for CommandOptions.runIn.
CommandRunInUnion	The allowed values for CommandOptions.runIn.
ContextMenuCommand	-
DetailedDescriptionCommand	-
InteractionHandlerParseResult	-
LogMethods	-
MessageArgumentContext	The context for the 'message' argument.
MessageCommand	-
PreconditionArrayResolvable	Defines the data accepted by PreconditionContainerArray's constructor.
PreconditionContainerResult	Defines the result's value for a PreconditionContainer.
PreconditionContainerReturn	Defines the return type of the generic IPreconditionContainer.messageRun.
PreconditionEntryResolvable	Defines the data accepted for each entry of the array.
PreconditionKeys	-
PreconditionResult	-
PreconditionSingleResolvable	Defines the data accepted by PreconditionContainerSingle's constructor.
ResultType	-
SapphirePrefix	A valid prefix in Sapphire. * string: a single prefix, e.g. '!'. * string[]: an array of prefixes, e.g. ['!', '.']. * null: disabled prefix, locks the bot's command usage to mentions only.
SimplePreconditionKeys	-
SyncPluginHooks	-

Variables

Variable	Description
ApplicationCommandRegistries	-
CorePreconditions	-
Events	-
InteractionHandlerFilters	-
PreconditionConditionAnd	An IPreconditionCondition which runs all containers similarly to doing (V0 && V1 [&& V2 [&& V3 ...]]).
PreconditionConditionOr	An IPreconditionCondition which runs all containers similarly to doing (V0
postInitialization	-
postLogin	-
preGenericsInitialization	-
preInitialization	-
preLogin	-
version	The @sapphire/framework version that you are currently using. An example use of this is showing it of in a bot information command.