Class Context

constructor

• new Context(bot, data): Context

• Parameters

  • bot: Erine<ClientEvents>

  • data: CommandInteraction<AnyInteractionChannel | Uncached> | Message<Uncached | AnyTextableChannel>

  Returns Context

args

bot

command

data

params

parent

Optional prefix

author

• get author(): User

• Points to the author (Erine.User) that used this command

  Returns User

channel

• get channel(): null | AnyTextableChannel

• Points to the channel where this command was executed (if any)

  Returns null | AnyTextableChannel

guild

• get guild(): null | Guild

• Points to the guild where this command was executed (if any)

  Returns null | Guild

interaction

• get interaction(): null | CommandInteraction<AnyInteractionChannel | Uncached>

• Points to the interaction

  Returns null | CommandInteraction<AnyInteractionChannel | Uncached>

  The interaction executhing this command (if any)

member

• get member(): null | Member

• Points to the member author (Erine.Member) that used this command

  Returns null | Member

message

• get message(): null | Message<Uncached | AnyTextableChannel>

• Points to the message

  Returns null | Message<Uncached | AnyTextableChannel>

  The message executing this command (if any)

signature

• get signature(): string

• Points to the full command name, including group

  Returns string

defer

• defer(options?): Promise<void>

• If a prefix command was used this is equivalent to 'AnyTextChannelWithoutGroup.sendTyping()', otherwise 'CommandInteraction.defer()'

  Parameters

  • Optional options: {
        ephemeral?: boolean;
    }

    The defer options

    • Optional ephemeral?: boolean

  Returns Promise<void>

followUp

• followUp(options): Promise<null | Message<Uncached | AnyTextableChannel>>

• Parameters

  • options: string | CreateMessageOptions | InitialInteractionContent

  Returns Promise<null | Message<Uncached | AnyTextableChannel>>

get

• get<T>(param, defaultValue?): null | T

• Get a parameter value

  Type Parameters

  • T

  Parameters

  • param: string

    The parameter name, you have to use Param decorator before

  • defaultValue: any = null

    If there is not a value for that parameter this value will be returned

  Returns null | T

  The parameter value, an attachment, string, number, boolean, role, member, channel or null

send

• send(options): Promise<null | Message<Uncached | AnyTextableChannel>>

• If a prefix command was used this is equivalent to 'AnyTextChannelWithoutGroup.createMessage()', otherwise 'CommandInteraction.createMessage()'

  Parameters

  • options: string | CreateMessageOptions | InitialInteractionContent

    The options to send the reply

  Returns Promise<null | Message<Uncached | AnyTextableChannel>>

  The message object