Skip to main content
Version: 1.x

ContextParameters

ContextParameters​

commandkitContext.ts

Parameters required to create a command context.

Signature
interface ContextParameters<T extends CommandExecutionMode, Args = Record<string, any>> {
    command: LoadedCommand;
    environment?: CommandKitEnvironment;
    executionMode: T;
    interaction: T extends 'chatInput'
    ? ChatInputCommandInteraction
    : T extends 'messageContextMenu'
      ? MessageContextMenuCommandInteraction
      : T extends 'userContextMenu'
        ? UserContextMenuCommandInteraction
        : T extends 'autocomplete'
          ? AutocompleteInteraction
          : never;
    message: T extends 'message' ? Message : never;
    forwarded?: boolean;
    messageCommandParser?: T extends 'message' ? MessageCommandParser : never;
    store?: Collection<string, any>;
    customArgs?: Args;
}

command​

property
LoadedCommand

environment​

property
CommandKitEnvironment

executionMode​

property
T

interaction​

property
T extends 'chatInput' ? ChatInputCommandInteraction : T extends 'messageContextMenu' ? MessageContextMenuCommandInteraction : T extends 'userContextMenu' ? UserContextMenuCommandInteraction : T extends 'autocomplete' ? AutocompleteInteraction : never

message​

property
T extends 'message' ? Message : never

forwarded​

property
boolean

messageCommandParser​

property
T extends 'message' ? MessageCommandParser : never

store​

property
Collection<string, any>

customArgs​

property
Args