Class CommandContext<T, M>

Type Parameters

T extends OptionsRecord = {}
M extends keyof RegisteredMiddlewares = never

Hierarchy (View Summary)

BaseContext
ExtendContext
- CommandContext

Constructors

constructor

new CommandContext<T extends OptionsRecord = {}, M extends never = never>(
    client: UsingClient,
    data: Message | ChatInputCommandInteraction<boolean>,
    resolver: OptionResolver,
    shardId: number,
    command: Command | SubCommand,
): CommandContext<T, M>
Type Parameters
- T extends OptionsRecord = {}
- M extends never = never
Parameters
- client: UsingClient
- data: Message | ChatInputCommandInteraction<boolean>
- resolver: OptionResolver
- shardId: number
- command: Command | SubCommand
Returns CommandContext<T, M>
Inherited from BaseContext.constructor
- Defined in src/commands/applications/chatcontext.ts:42

Properties

`Readonly`client

client: UsingClient

`Readonly`command

command: Command | SubCommand

globalMetadata

globalMetadata: GlobalMetadata = {}

interaction

interaction: ChatInputCommandInteraction<boolean>

message

message: undefined

`Optional`messageResponse

messageResponse?: null | Message

metadata

metadata: CommandMetadata<UnionToTuple<M, []>> = ...

options

options: ContextOptions<T> = ...

`Readonly`resolver

resolver: OptionResolver

`Readonly`shardId

shardId: number

Accessors

author

get author(): User
Returns User
- Defined in src/commands/applications/chatcontext.ts:209

channelId

get channelId(): string
Returns string
- Defined in src/commands/applications/chatcontext.ts:205

fullCommandName

get fullCommandName(): string
Returns string
- Defined in src/commands/applications/chatcontext.ts:65

guildId

get guildId(): undefined | string
Returns undefined | string
- Defined in src/commands/applications/chatcontext.ts:201

member

get member(): undefined | InteractionGuildMember
Returns undefined | InteractionGuildMember
- Defined in src/commands/applications/chatcontext.ts:213

proxy

get proxy(): APIRoutes
Gets the proxy object.

Returns APIRoutes
Inherited from BaseContext.proxy
- Defined in src/commands/basecontext.ts:15

t

get t(): __InternalParseLocale<DefaultLocale> & {
get(locale?: string): DefaultLocale;
}
Returns __InternalParseLocale<DefaultLocale> & { get(locale?: string): DefaultLocale }
- Defined in src/commands/applications/chatcontext.ts:61

Methods

channel

channel(mode?: "rest" | "flow"): Promise<AllChannels>
Parameters
- Optionalmode: "rest" | "flow"
Returns Promise<AllChannels>
- Defined in src/commands/applications/chatcontext.ts:153
channel(mode: "cache"): ReturnCache<AllChannels>
Parameters
- mode: "cache"
Returns ReturnCache<AllChannels>
- Defined in src/commands/applications/chatcontext.ts:154

deferReply

deferReply<WR extends boolean = false>(
ephemeral?: boolean,
withResponse?: WR,
): Promise<When<WR, WebhookMessage, undefined>>
Type Parameters
- WR extends boolean = false
Parameters
- ephemeral: boolean = false
- OptionalwithResponse: WR
Returns Promise<When<WR, WebhookMessage, undefined>>
- Defined in src/commands/applications/chatcontext.ts:86

deleteResponse

deleteResponse(): Promise<void>
Returns Promise<void>
- Defined in src/commands/applications/chatcontext.ts:117

editOrReply

editOrReply<WR extends boolean = false>(
    body:
        | Omit<
            APIInteractionResponseCallbackData,
            "components"
            | "content"
            | "embeds"
            | "poll",
        > & SendResolverProps
        | InteractionMessageUpdateBodyRequest,
    withResponse?: WR,
): Promise<When<WR, WebhookMessage, void | WebhookMessage>>
Type Parameters
- WR extends boolean = false
Parameters
- body:
      | Omit<
          APIInteractionResponseCallbackData,
          "components"
          | "content"
          | "embeds"
          | "poll",
      > & SendResolverProps
      | InteractionMessageUpdateBodyRequest
- OptionalwithResponse: WR
Returns Promise<When<WR, WebhookMessage, void | WebhookMessage>>
- Defined in src/commands/applications/chatcontext.ts:122

editResponse

editResponse(body: InteractionMessageUpdateBodyRequest): Promise<WebhookMessage>
Parameters
- body: InteractionMessageUpdateBodyRequest
Returns Promise<WebhookMessage>
- Defined in src/commands/applications/chatcontext.ts:105

fetchResponse

fetchResponse(): Promise<WebhookMessage>
Returns Promise<WebhookMessage>
- Defined in src/commands/applications/chatcontext.ts:146

followup

followup(
    body: Omit<
        RESTPostAPIWebhookWithTokenJSONBody,
        "components"
        | "content"
        | "embeds"
        | "poll",
    > & SendResolverProps,
): Promise<WebhookMessage>
Parameters
- body: Omit<
      RESTPostAPIWebhookWithTokenJSONBody,
      "components"
      | "content"
      | "embeds"
      | "poll",
  > & SendResolverProps
Returns Promise<WebhookMessage>
- Defined in src/commands/applications/chatcontext.ts:139

guild

guild(
mode?: "rest" | "flow",
query?: RESTGetAPIGuildQuery,
): Promise<undefined | Guild<"cached" | "api">>
Parameters
- Optionalmode: "rest" | "flow"
- Optionalquery: RESTGetAPIGuildQuery
Returns Promise<undefined | Guild<"cached" | "api">>
- Defined in src/commands/applications/chatcontext.ts:185
guild(
mode: "cache",
query?: RESTGetAPIGuildQuery,
): ReturnCache<undefined | Guild<"cached">>
Parameters
- mode: "cache"
- Optionalquery: RESTGetAPIGuildQuery
Returns ReturnCache<undefined | Guild<"cached">>
- Defined in src/commands/applications/chatcontext.ts:186

inGuild

inGuild(): this is GuildCommandContext<T, M>
Returns this is GuildCommandContext<T, M>
- Defined in src/commands/applications/chatcontext.ts:225

isButton

isButton(): this is ComponentContext<"Button", never>
Returns this is ComponentContext<"Button", never>
Inherited from BaseContext.isButton
- Defined in src/commands/basecontext.ts:43

isChannelSelectMenu

isChannelSelectMenu(): this is ComponentContext<"ChannelSelect", never>
Returns this is ComponentContext<"ChannelSelect", never>
Inherited from BaseContext.isChannelSelectMenu
- Defined in src/commands/basecontext.ts:47

isChat

isChat(): this is CommandContext<T, M>
Returns this is CommandContext<T, M>
Inherited from BaseContext.isChat
- Defined in src/commands/applications/chatcontext.ts:221

isComponent

isComponent(): this is ComponentContext<
keyof ContextComponentCommandInteractionMap,
never,
>
Returns this is ComponentContext<keyof ContextComponentCommandInteractionMap, never>
Inherited from BaseContext.isComponent
- Defined in src/commands/basecontext.ts:35

isEntryPoint

isEntryPoint(): this is EntryPointContext<never>
Returns this is EntryPointContext<never>
Inherited from BaseContext.isEntryPoint
- Defined in src/commands/basecontext.ts:67

isMentionableSelectMenu

isMentionableSelectMenu(): this is ComponentContext<"MentionableSelect", never>
Returns this is ComponentContext<"MentionableSelect", never>
Inherited from BaseContext.isMentionableSelectMenu
- Defined in src/commands/basecontext.ts:55

isMenu

isMenu(): this is MenuCommandContext<
    UserCommandInteraction<boolean>
    | MessageCommandInteraction<boolean>,
    never,
>
Returns this is MenuCommandContext<
    UserCommandInteraction<boolean>
    | MessageCommandInteraction<boolean>,
    never,
>
Inherited from BaseContext.isMenu
- Defined in src/commands/basecontext.ts:23

isMenuMessage

isMenuMessage(): this is MenuCommandContext<
MessageCommandInteraction<boolean>,
never,
>
Returns this is MenuCommandContext<MessageCommandInteraction<boolean>, never>
Inherited from BaseContext.isMenuMessage
- Defined in src/commands/basecontext.ts:31

isMenuUser

isMenuUser(): this is MenuCommandContext<UserCommandInteraction<boolean>, never>
Returns this is MenuCommandContext<UserCommandInteraction<boolean>, never>
Inherited from BaseContext.isMenuUser
- Defined in src/commands/basecontext.ts:27

isModal

isModal(): this is ModalContext<never>
Returns this is ModalContext<never>
Inherited from BaseContext.isModal
- Defined in src/commands/basecontext.ts:39

isRoleSelectMenu

isRoleSelectMenu(): this is ComponentContext<"RoleSelect", never>
Returns this is ComponentContext<"RoleSelect", never>
Inherited from BaseContext.isRoleSelectMenu
- Defined in src/commands/basecontext.ts:51

isStringSelectMenu

isStringSelectMenu(): this is ComponentContext<"StringSelect", never>
Returns this is ComponentContext<"StringSelect", never>
Inherited from BaseContext.isStringSelectMenu
- Defined in src/commands/basecontext.ts:63

isUserSelectMenu

isUserSelectMenu(): this is ComponentContext<"UserSelect", never>
Returns this is ComponentContext<"UserSelect", never>
Inherited from BaseContext.isUserSelectMenu
- Defined in src/commands/basecontext.ts:59

me

me(mode?: "rest" | "flow"): Promise<undefined | GuildMember>
Parameters
- Optionalmode: "rest" | "flow"
Returns Promise<undefined | GuildMember>
- Defined in src/commands/applications/chatcontext.ts:169
me(mode: "cache"): ReturnCache<undefined | GuildMember>
Parameters
- mode: "cache"
Returns ReturnCache<undefined | GuildMember>
- Defined in src/commands/applications/chatcontext.ts:170

write

write<WR extends boolean = false>(
    body: Omit<
        APIInteractionResponseCallbackData,
        "components"
        | "content"
        | "embeds"
        | "poll",
    > & SendResolverProps,
    withResponse?: WR,
): Promise<When<WR, WebhookMessage, void | WebhookMessage>>
Type Parameters
- WR extends boolean = false
Parameters
- body: Omit<
      APIInteractionResponseCallbackData,
      "components"
      | "content"
      | "embeds"
      | "poll",
  > & SendResolverProps
- OptionalwithResponse: WR
Returns Promise<When<WR, WebhookMessage, void | WebhookMessage>>
- Defined in src/commands/applications/chatcontext.ts:69

Class CommandContext<T, M>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns CommandContext<T, M>

Properties

Readonlyclient

Readonlycommand

globalMetadata

interaction

message

OptionalmessageResponse

metadata

options

Readonlyresolver

ReadonlyshardId

Accessors

author

Returns User

channelId

Returns string

fullCommandName

Returns string

guildId

Returns undefined | string

member

Returns undefined | InteractionGuildMember

proxy

Returns APIRoutes

t

Returns __InternalParseLocale<DefaultLocale> & { get(locale?: string): DefaultLocale }

Methods

channel

Parameters

Returns Promise<AllChannels>

Parameters

Returns ReturnCache<AllChannels>

deferReply

Type Parameters

Parameters

Returns Promise<When<WR, WebhookMessage, undefined>>

deleteResponse

Returns Promise<void>

editOrReply

Type Parameters

Parameters

Returns Promise<When<WR, WebhookMessage, void | WebhookMessage>>

editResponse

Parameters

Returns Promise<WebhookMessage>

fetchResponse

Returns Promise<WebhookMessage>

followup

Parameters

Returns Promise<WebhookMessage>

guild

Parameters

Returns Promise<undefined | Guild<"cached" | "api">>

Parameters

Returns ReturnCache<undefined | Guild<"cached">>

inGuild

Returns this is GuildCommandContext<T, M>

isButton

Returns this is ComponentContext<"Button", never>

isChannelSelectMenu

Returns this is ComponentContext<"ChannelSelect", never>

isChat

Returns this is CommandContext<T, M>

isComponent

Returns this is ComponentContext<keyof ContextComponentCommandInteractionMap, never>

isEntryPoint

Returns this is EntryPointContext<never>

`Readonly`client

`Readonly`command

`Optional`messageResponse

`Readonly`resolver

`Readonly`shardId

Returns this is MenuCommandContext<
UserCommandInteraction<boolean>
| MessageCommandInteraction<boolean>,
never,
>