@sapphire/framework
Namespaces
- AliasPiece
- AllFlowsPrecondition
- ApplicationCommandRegistry
- Argument
- ArgumentError
- AutocompleteCommand
- ChatInputCommand
- Command
- ContextMenuCommand
- CorePreconditions
- InteractionHandler
- Listener
- MessageCommand
- Piece
- Precondition
- PreconditionError
- Resolvers
- Store
- UserError
Enumerations
- BucketScope
- CommandOptionsRunTypeEnum
- CommandPreConditions
- CooldownLevel
- Identifiers
- InteractionHandlerTypes
- InternalRegistryAPIType
- LogLevel
- PluginHook
- PreconditionRunCondition
- PreconditionRunMode
- RegisterBehavior
Classes
- AliasPiece
- AliasStore
- AllFlowsPrecondition
- ApplicationCommandRegistry
- Args
- Argument
- ArgumentError
- ArgumentStore
- ClientPermissionsPrecondition
- Command
- CommandStore
- InteractionHandler
- InteractionHandlerStore
- Listener
- ListenerStore
- LoaderError
- Logger
- MissingExportsError
- Piece
- Plugin
- PluginManager
- Precondition
- PreconditionContainerArray
- PreconditionContainerSingle
- PreconditionError
- PreconditionStore
- SapphireClient
- Store
- StoreRegistry
- UserError
- UserPermissionsPrecondition
Interfaces
- AliasPieceOptions
- ArgOptions
- ArgType
- ArgsNextCallback
- ArgumentContext
- ArgumentOptions
- AutocompleteCommandContext
- AutocompleteInteractionPayload
- ChatInputCommandAcceptedPayload
- ChatInputCommandContext
- ChatInputCommandDeniedPayload
- ChatInputCommandErrorPayload
- ChatInputCommandFinishPayload
- ChatInputCommandRunPayload
- ChatInputCommandSuccessPayload
- ClientLoggerOptions
- CommandChatInputRegisterShortcut
- CommandDoesNotHaveChatInputCommandHandlerPayload
- CommandDoesNotHaveContextMenuCommandHandlerPayload
- CommandDoesNotHaveMessageCommandHandler
- CommandJSON
- CommandOptions
- ContextMenuCommandAcceptedPayload
- ContextMenuCommandContext
- ContextMenuCommandDeniedPayload
- ContextMenuCommandErrorPayload
- ContextMenuCommandFinishPayload
- ContextMenuCommandRunPayload
- ContextMenuCommandSuccessPayload
- CooldownOptions
- DetailedDescriptionCommandObject
- Err
- IArgument
- IChatInputCommandPayload
- IContextMenuCommandPayload
- IInteractionHandlerPayload
- ILogger
- IMessageCommandPayload
- IPieceError
- IPreconditionCondition
- IPreconditionContainer
- InteractionHandlerError
- InteractionHandlerJSON
- InteractionHandlerOptions
- InteractionHandlerParseError
- ListenerErrorPayload
- ListenerJSON
- ListenerOptions
- MessageCommandAcceptedPayload
- MessageCommandContext
- MessageCommandDeniedPayload
- MessageCommandErrorPayload
- MessageCommandFinishPayload
- MessageCommandRunPayload
- MessageCommandSuccessPayload
- MessageCommandTypingErrorPayload
- None
- Ok
- PieceContext
- PieceOptions
- PreChatInputCommandRunPayload
- PreContextMenuCommandRunPayload
- PreMessageCommandRunPayload
- PreconditionArrayResolvableDetails
- PreconditionContext
- PreconditionOptions
- PreconditionSingleResolvableDetails
- Preconditions
- RepeatArgOptions
- SapphireClientOptions
- SapphirePluginAsyncHook
- SapphirePluginHook
- SapphirePluginHookEntry
- SapphirePrefixHook
- SimplePreconditionSingleResolvableDetails
- Some
- StoreOptions
- StoreRegistryEntries
- UnknownChatInputCommandPayload
- UnknownContextMenuCommandPayload
- UnknownMessageCommandNamePayload
- UnknownMessageCommandPayload
Type Aliases
ApplicationCommandRegistryRegisterOptions
Ƭ ApplicationCommandRegistryRegisterOptions: RegisterOptions
Defined in
projects/framework/src/lib/utils/application-commands/ApplicationCommandRegistry.ts:461
ArgumentResult
Ƭ ArgumentResult<T>: Awaitable<Result<T, UserError>>
Type parameters
| Name |
|---|
T |
Defined in
projects/framework/src/lib/structures/Argument.ts:13
AsyncArgumentResult
Ƭ AsyncArgumentResult<T>: Promise<Result<T, UserError>>
Type parameters
| Name |
|---|
T |
Defined in
projects/framework/src/lib/structures/Argument.ts:18
AsyncPluginHooks
Ƭ AsyncPluginHooks: PreLogin | PostLogin
Defined in
projects/framework/src/lib/plugins/PluginManager.ts:8
AsyncPreconditionContainerReturn
Ƭ AsyncPreconditionContainerReturn: Promise<PreconditionContainerResult>
Defined in
projects/framework/src/lib/utils/preconditions/IPreconditionContainer.ts:24
AsyncPreconditionResult
Ƭ AsyncPreconditionResult: Promise<Result<unknown, UserError>>
Defined in
projects/framework/src/lib/structures/Precondition.ts:11
AutocompleteCommand
Ƭ AutocompleteCommand: Command & Required<Pick<Command, "autocompleteRun">>
Defined in
projects/framework/src/lib/structures/Command.ts:513
Awaitable
Ƭ Awaitable<T>: PromiseLike<T> | T
Type parameters
| Name |
|---|
T |
Defined in
node_modules/@sapphire/utilities/dist/lib/utilityTypes.d.ts:44
ChatInputCommand
Ƭ ChatInputCommand: Command & Required<Pick<Command, "chatInputRun">>
Defined in
projects/framework/src/lib/structures/Command.ts:489
CommandOptionsRunType
Ƭ CommandOptionsRunType: "DM" | "GUILD_TEXT" | "GUILD_VOICE" | "GUILD_NEWS" | "GUILD_NEWS_THREAD" | "GUILD_PUBLIC_THREAD" | "GUILD_PRIVATE_THREAD" | "GUILD_ANY"
Defined in
projects/framework/src/lib/structures/Command.ts:530
ContextMenuCommand
Ƭ ContextMenuCommand: Command & Required<Pick<Command, "contextMenuRun">>
Defined in
projects/framework/src/lib/structures/Command.ts:501
DetailedDescriptionCommand
Ƭ DetailedDescriptionCommand: string | DetailedDescriptionCommandObject
Defined in
projects/framework/src/lib/structures/Command.ts:828
InteractionHandlerParseResult
Ƭ InteractionHandlerParseResult<Instance>: UnwrapMaybeValue<Awaited<ReturnType<Instance["parse"]>>>
Type parameters
| Name | Type |
|---|---|
Instance | extends InteractionHandler |
Defined in
projects/framework/src/lib/structures/InteractionHandler.ts:97
LogMethods
Ƭ LogMethods: "trace" | "debug" | "info" | "warn" | "error"
Defined in
projects/framework/src/lib/utils/logger/Logger.ts:54
Maybe
Type parameters
| Name | Description |
|---|---|
T |
Defined in
node_modules/@sapphire/result/dist/lib/Maybe.d.ts:6
MessageCommand
Ƭ MessageCommand: Command & Required<Pick<Command, "messageRun">>
Defined in
projects/framework/src/lib/structures/Command.ts:479
Option
Type parameters
| Name | Description |
|---|---|
T |
Defined in
node_modules/@sapphire/result/dist/lib/Lexure.d.ts:45
PreconditionArrayResolvable
Ƭ PreconditionArrayResolvable: readonly PreconditionEntryResolvable[] | PreconditionArrayResolvableDetails
Defined in
projects/framework/src/lib/utils/preconditions/PreconditionContainerArray.ts:75
PreconditionContainerResult
Ƭ PreconditionContainerResult: Result<unknown, UserError>
Defined in
projects/framework/src/lib/utils/preconditions/IPreconditionContainer.ts:12
PreconditionContainerReturn
Ƭ PreconditionContainerReturn: Awaitable<PreconditionContainerResult>
Defined in
projects/framework/src/lib/utils/preconditions/IPreconditionContainer.ts:18
PreconditionEntryResolvable
Ƭ PreconditionEntryResolvable: PreconditionSingleResolvable | PreconditionArrayResolvable
Defined in
projects/framework/src/lib/utils/preconditions/PreconditionContainerArray.ts:83
PreconditionKeys
Ƭ PreconditionKeys: keyof Preconditions
Defined in
projects/framework/src/lib/structures/Precondition.ts:129
PreconditionResult
Ƭ PreconditionResult: Awaitable<Result<unknown, UserError>>
Defined in
projects/framework/src/lib/structures/Precondition.ts:10
PreconditionSingleResolvable
Ƭ PreconditionSingleResolvable: SimplePreconditionKeys | SimplePreconditionSingleResolvableDetails | PreconditionSingleResolvableDetails
Defined in
projects/framework/src/lib/utils/preconditions/PreconditionContainerSingle.ts:43
Result
Ƭ Result<T, E>: Ok<T> | Err<E>
Type parameters
| Name | Description |
|---|---|
T | |
E |
Defined in
node_modules/@sapphire/result/dist/lib/Result.d.ts:7
SapphirePrefix
Ƭ SapphirePrefix: string | readonly string[] | null
Defined in
projects/framework/src/lib/SapphireClient.ts:26
SimplePreconditionKeys
Ƭ SimplePreconditionKeys: { [K in PreconditionKeys]: Preconditions[K] extends never ? K : never }[PreconditionKeys]
Defined in
projects/framework/src/lib/structures/Precondition.ts:130
SyncPluginHooks
Ƭ SyncPluginHooks: Exclude<PluginHook, AsyncPluginHooks>
Defined in
projects/framework/src/lib/plugins/PluginManager.ts:13
UnwrapMaybeValue
Ƭ UnwrapMaybeValue<T>: T extends Some<infer V> ? V : never
Type parameters
| Name | Type |
|---|---|
T | extends Maybe<unknown> |
Defined in
node_modules/@sapphire/result/dist/lib/Maybe.d.ts:64
Variables
ApplicationCommandRegistries
• Const ApplicationCommandRegistries: Object
Type declaration
| Name | Type |
|---|---|
acquire | (commandName: string) => ApplicationCommandRegistry |
getDefaultBehaviorWhenNotIdentical | () => RegisterBehavior |
setDefaultBehaviorWhenNotIdentical | (behavior?: null | RegisterBehavior) => void |
get registries() | ReadonlyMap<string, ApplicationCommandRegistry> |
Defined in
projects/framework/src/index.ts:23
CorePreconditions
• Const CorePreconditions: Object
Type declaration
| Name | Type |
|---|---|
ClientPermissions | typeof CorePrecondition |
Cooldown | typeof CorePrecondition |
DMOnly | typeof CorePrecondition |
Enabled | typeof CorePrecondition |
GuildNewsOnly | typeof CorePrecondition |
GuildNewsThreadOnly | typeof CorePrecondition |
GuildOnly | typeof CorePrecondition |
GuildPrivateThreadOnly | typeof CorePrecondition |
GuildPublicThreadOnly | typeof CorePrecondition |
GuildTextOnly | typeof CorePrecondition |
GuildThreadOnly | typeof CorePrecondition |
GuildVoiceOnly | typeof CorePrecondition |
NSFW | typeof CorePrecondition |
UserPermissions | typeof CorePrecondition |
Defined in
projects/framework/src/index.ts:84
Events
• Const Events: Object
Type declaration
| Name | Type | Description |
|---|---|---|
ChannelCreate | "channelCreate" | - |
ChannelDelete | "channelDelete" | - |
ChannelPinsUpdate | "channelPinsUpdate" | - |
ChannelUpdate | "channelUpdate" | - |
ChatInputCommandAccepted | "chatInputCommandAccepted" | |
ChatInputCommandDenied | "chatInputCommandDenied" | |
ChatInputCommandError | "chatInputCommandError" | |
ChatInputCommandFinish | "chatInputCommandFinish" | |
ChatInputCommandRun | "chatInputCommandRun" | |
ChatInputCommandSuccess | "chatInputCommandSuccess" | |
ClientReady | "ready" | - |
CommandApplicationCommandRegistryError | "commandApplicationCommandRegistryError" | |
CommandAutocompleteInteractionError | "commandAutocompleteInteractionError" | |
CommandAutocompleteInteractionSuccess | "commandAutocompleteInteractionSuccess" | |
CommandDoesNotHaveChatInputCommandHandler | "commandDoesNotHaveChatInputCommandHandler" | |
CommandDoesNotHaveContextMenuCommandHandler | "commandDoesNotHaveContextMenuCommandHandler" | |
CommandDoesNotHaveMessageCommandHandler | "commandDoesNotHaveMessageCommandHandler" | |
ContextMenuCommandAccepted | "contextMenuCommandAccepted" | |
ContextMenuCommandDenied | "contextMenuCommandDenied" | |
ContextMenuCommandError | "contextMenuCommandError" | |
ContextMenuCommandFinish | "contextMenuCommandFinish" | |
ContextMenuCommandRun | "contextMenuCommandRun" | |
ContextMenuCommandSuccess | "contextMenuCommandSuccess" | |
Debug | "debug" | - |
Error | "error" | - |
GuildBanAdd | "guildBanAdd" | - |
GuildBanRemove | "guildBanRemove" | - |
GuildCreate | "guildCreate" | - |
GuildDelete | "guildDelete" | - |
GuildEmojiCreate | "emojiCreate" | - |
GuildEmojiDelete | "emojiDelete" | - |
GuildEmojiUpdate | "emojiUpdate" | - |
GuildIntegrationsUpdate | "guildIntegrationsUpdate" | - |
GuildMemberAdd | "guildMemberAdd" | - |
GuildMemberAvailable | "guildMemberAvailable" | - |
GuildMemberRemove | "guildMemberRemove" | - |
GuildMemberUpdate | "guildMemberUpdate" | - |
GuildMembersChunk | "guildMembersChunk" | - |
GuildRoleCreate | "roleCreate" | - |
GuildRoleDelete | "roleDelete" | - |
GuildRoleUpdate | "roleUpdate" | - |
GuildStickerCreate | "stickerCreate" | - |
GuildStickerDelete | "stickerDelete" | - |
GuildStickerUpdate | "stickerUpdate" | - |
GuildUnavailable | "guildUnavailable" | - |
GuildUpdate | "guildUpdate" | - |
InteractionCreate | "interactionCreate" | - |
InteractionHandlerError | "interactionHandlerError" | |
InteractionHandlerParseError | "interactionHandlerParseError" | |
InvalidRequestWarning | "invalidRequestWarning" | - |
Invalidated | "invalidated" | - |
InviteCreate | "inviteCreate" | - |
InviteDelete | "inviteDelete" | - |
ListenerError | "listenerError" | |
MentionPrefixOnly | "mentionPrefixOnly" | |
MessageBulkDelete | "messageDeleteBulk" | - |
MessageCommandAccepted | "messageCommandAccepted" | |
MessageCommandDenied | "messageCommandDenied" | |
MessageCommandError | "messageCommandError" | |
MessageCommandFinish | "messageCommandFinish" | |
MessageCommandRun | "messageCommandRun" | |
MessageCommandSuccess | "messageCommandSuccess" | |
MessageCommandTypingError | "messageCommandTypingError" | |
MessageCreate | "messageCreate" | - |
MessageDelete | "messageDelete" | - |
MessageReactionAdd | "messageReactionAdd" | - |
MessageReactionRemove | "messageReactionRemove" | - |
MessageReactionRemoveAll | "messageReactionRemoveAll" | - |
MessageReactionRemoveEmoji | "messageReactionRemoveEmoji" | - |
MessageUpdate | "messageUpdate" | - |
NonPrefixedMessage | "nonPrefixedMessage" | |
PiecePostLoad | "piecePostLoad" | |
PieceUnload | "pieceUnload" | |
PluginLoaded | "pluginLoaded" | |
PossibleAutocompleteInteraction | "possibleAutocompleteInteraction" | |
PossibleChatInputCommand | "possibleChatInputCommand" | |
PossibleContextMenuCommand | "possibleContextMenuCommand" | |
PreChatInputCommandRun | "preChatInputCommandRun" | |
PreContextMenuCommandRun | "preContextMenuCommandRun" | |
PreMessageCommandRun | "preMessageCommandRun" | |
PreMessageParsed | "preMessageParsed" | |
PrefixedMessage | "prefixedMessage" | |
PresenceUpdate | "presenceUpdate" | - |
RateLimit | "rateLimit" | - |
Raw | "raw" | - |
ShardDisconnect | "shardDisconnect" | - |
ShardError | "shardError" | - |
ShardReady | "shardReady" | - |
ShardReconnecting | "shardReconnecting" | - |
ShardResume | "shardResume" | - |
StageInstanceCreate | "stageInstanceCreate" | - |
StageInstanceDelete | "stageInstanceDelete" | - |
StageInstanceUpdate | "stageInstanceUpdate" | - |
ThreadCreate | "threadCreate" | - |
ThreadDelete | "threadDelete" | - |
ThreadListSync | "threadListSync" | - |
ThreadMemberUpdate | "threadMemberUpdate" | - |
ThreadMembersUpdate | "threadMembersUpdate" | - |
ThreadUpdate | "threadUpdate" | - |
TypingStart | "typingStart" | - |
UnknownChatInputCommand | "unknownChatInputCommand" | |
UnknownContextMenuCommand | "unknownContextMenuCommand" | |
UnknownMessageCommand | "unknownMessageCommand" | |
UnknownMessageCommandName | "unknownMessageCommandName" | |
UserUpdate | "userUpdate" | - |
VoiceServerUpdate | "voiceServerUpdate" | - |
VoiceStateUpdate | "voiceStateUpdate" | - |
Warn | "warn" | - |
WebhooksUpdate | "webhookUpdate" | - |
Defined in
projects/framework/src/lib/types/Events.ts:18
InteractionHandlerFilters
• Const InteractionHandlerFilters: Map<InteractionHandlerTypes, (interaction: Interaction<CacheType>) => boolean>
Defined in
projects/framework/src/lib/structures/InteractionHandlerStore.ts:77
PreconditionConditionAnd
• Const PreconditionConditionAnd: IPreconditionCondition
Defined in
projects/framework/src/lib/utils/preconditions/conditions/PreconditionConditionAnd.ts:8
PreconditionConditionOr
• Const PreconditionConditionOr: IPreconditionCondition
Defined in
projects/framework/src/lib/utils/preconditions/conditions/PreconditionConditionOr.ts:9
container
• Const container: Container
Defined in
node_modules/@sapphire/pieces/dist/index.d.ts:642
postInitialization
• Const postInitialization: unique symbol
Defined in
projects/framework/src/lib/plugins/symbols.ts:3
postLogin
• Const postLogin: unique symbol
Defined in
projects/framework/src/lib/plugins/symbols.ts:6
preGenericsInitialization
• Const preGenericsInitialization: unique symbol
Defined in
projects/framework/src/lib/plugins/symbols.ts:1
preInitialization
• Const preInitialization: unique symbol
Defined in
projects/framework/src/lib/plugins/symbols.ts:2
preLogin
• Const preLogin: unique symbol
Defined in
projects/framework/src/lib/plugins/symbols.ts:5
version
• Const version: string = '[VI]{version}[/VI]'
Defined in
projects/framework/src/index.ts:113
Functions
err
▸ err(): Err<unknown>
Returns
Err<unknown>
Defined in
node_modules/@sapphire/result/dist/lib/Result.d.ts:24
▸ err<E>(x): Err<E>
Type parameters
| Name | Description |
|---|---|
E |
Parameters
| Name | Type | Description |
|---|---|---|
x | E |
Returns
Err<E>
Defined in
node_modules/@sapphire/result/dist/lib/Result.d.ts:31
from
▸ from<T, E>(cb): Result<T, E>
Type parameters
| Name | Type | Description |
|---|---|---|
T | T | |
E | unknown |
Parameters
| Name | Type |
|---|---|
cb | (...args: unknown[]) => T |
Returns
Result<T, E>
Defined in
node_modules/@sapphire/result/dist/lib/Parsers.d.ts:7
fromAsync
▸ fromAsync<T, E>(promiseOrCb): Promise<Result<T, E>>
Type parameters
| Name | Type | Description |
|---|---|---|
T | T | |
E | unknown |
Parameters
| Name | Type |
|---|---|
promiseOrCb | Awaitable<T> | (...args: unknown[]) => Awaitable<T> |
Returns
Defined in
node_modules/@sapphire/result/dist/lib/Parsers.d.ts:13
isErr
▸ isErr<T, E>(x): x is Err<E>
Type parameters
| Name | Description |
|---|---|
T | |
E |
Parameters
| Name | Type |
|---|---|
x | Result<T, E> |
Returns
x is Err<E>
Defined in
node_modules/@sapphire/result/dist/lib/Result.d.ts:43
isMaybe
▸ isMaybe<T>(x): true
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
x | Maybe<T> |
Returns
true
Defined in
node_modules/@sapphire/result/dist/lib/Maybe.d.ts:58
▸ isMaybe<T>(x): x is Maybe<T>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
x | unknown |
Returns
x is Maybe<T>
Defined in
node_modules/@sapphire/result/dist/lib/Maybe.d.ts:63
isNone
▸ isNone<T>(x): x is None
Type parameters
| Name | Description |
|---|---|
T |
Parameters
| Name | Type |
|---|---|
x | Maybe<T> |
Returns
x is None
Defined in
node_modules/@sapphire/result/dist/lib/Maybe.d.ts:53
isOk
▸ isOk<T, E>(x): x is Ok<T>
Type parameters
| Name | Description |
|---|---|
T | |
E |
Parameters
| Name | Type |
|---|---|
x | Result<T, E> |
Returns
x is Ok<T>
Defined in
node_modules/@sapphire/result/dist/lib/Result.d.ts:37
isSome
▸ isSome<T>(x): x is Some<T>
Type parameters
| Name | Description |
|---|---|
T |
Parameters
| Name | Type |
|---|---|
x | Maybe<T> |
Returns
x is Some<T>
Defined in
node_modules/@sapphire/result/dist/lib/Maybe.d.ts:48
maybe
▸ maybe<T, V>(value): V
Type parameters
| Name | Type |
|---|---|
T | T |
V | extends Maybe<T> |
Parameters
| Name | Type | Description |
|---|---|---|
value | V |
Returns
V
Defined in
node_modules/@sapphire/result/dist/lib/Maybe.d.ts:11
▸ maybe(value): None
Parameters
| Name | Type | Description |
|---|---|---|
value | null | None |
Returns
Defined in
node_modules/@sapphire/result/dist/lib/Maybe.d.ts:16
▸ maybe<T>(value): Maybe<T>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
value | null | T | Maybe<T> |
Returns
Maybe<T>
Defined in
node_modules/@sapphire/result/dist/lib/Maybe.d.ts:21
▸ maybe<T>(value): Some<T>
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
value | T | Some<T> |
Returns
Some<T>
Defined in
node_modules/@sapphire/result/dist/lib/Maybe.d.ts:26
none
▸ none(): None
Returns
Defined in
node_modules/@sapphire/result/dist/lib/Maybe.d.ts:43
ok
▸ ok(): Ok<unknown>
Returns
Ok<unknown>
Defined in
node_modules/@sapphire/result/dist/lib/Result.d.ts:12
▸ ok<T>(x): Ok<T>
Type parameters
| Name | Description |
|---|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
x | T |
Returns
Ok<T>
Defined in
node_modules/@sapphire/result/dist/lib/Result.d.ts:19
some
▸ some(): Some<unknown>
Returns
Some<unknown>
Defined in
node_modules/@sapphire/result/dist/lib/Maybe.d.ts:31
▸ some<T>(x): Some<T>
Type parameters
| Name | Description |
|---|---|
T |
Parameters
| Name | Type | Description |
|---|---|---|
x | T |
Returns
Some<T>
Defined in
node_modules/@sapphire/result/dist/lib/Maybe.d.ts:38