Options
All
  • Public
  • Public/Protected
  • All
Menu

Class BaseRequest<Body>

Type parameters

  • Body = unknown

Hierarchy

Index

Constructors

Properties

Accessors

Constructors

constructor

  • new BaseRequest<Body>(trigger: Message<boolean> | CommandInteraction<CacheType>): BaseRequest<Body>

  • Type parameters

    • Body = unknown

    Parameters

    • trigger: Message<boolean> | CommandInteraction<CacheType>

    Returns BaseRequest<Body>

Properties

Readonly appId

appId: null | string

Abstract body

body: Body

Arguments and options passed from the command

Readonly channel

channel: null | TextBasedChannel

Readonly channelId

channelId: null | string

Readonly client

client: null | Client<boolean>

command

command: [command?: string, subcommandGroup?: string, subcommand?: string] = []

Command details. Note that for message commands, positional arguments are inserted even if they may not be subcommands or subcommand groups.

example
// A command that looks like this
const input = "!myCommand arg1 arg2 arg3"

// Will output this
const output = {
    body: {
        _: ["arg1", "arg2", "arg4"],
    },
    command: ["myCommand", "arg1", "arg2"],
}

Because of this ambiguity, the decision of how to treat this behaviour is up to the programmer later on. Note that this behaviour is properly handled by discord-express.

Readonly createdAt

createdAt: Date

Readonly createdTimestamp

createdTimestamp: number

Readonly guild

guild: null | Guild

Readonly guildId

guildId: null | string

Readonly id

id: string

Optional Readonly Abstract interaction

interaction?: CommandInteraction<CacheType>

Readonly Abstract member

member: null | GuildMember | APIInteractionGuildMember

Optional Readonly Abstract message

message?: Message<boolean>

metadata

metadata: {} = {}

Extra metadata that can be stored for any purpose

Type declaration

  • [key: string]: unknown

Readonly Abstract requestType

requestType: "message" | "interaction"

Readonly startAt

startAt: Date = ...

Readonly Abstract trigger

trigger: Message<boolean> | CommandInteraction<CacheType>

Readonly Abstract type

type: "DEFAULT" | "RECIPIENT_ADD" | "RECIPIENT_REMOVE" | "CALL" | "CHANNEL_NAME_CHANGE" | "CHANNEL_ICON_CHANGE" | "CHANNEL_PINNED_MESSAGE" | "GUILD_MEMBER_JOIN" | "USER_PREMIUM_GUILD_SUBSCRIPTION" | "USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_1" | "USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_2" | "USER_PREMIUM_GUILD_SUBSCRIPTION_TIER_3" | "CHANNEL_FOLLOW_ADD" | "GUILD_DISCOVERY_DISQUALIFIED" | "GUILD_DISCOVERY_REQUALIFIED" | "GUILD_DISCOVERY_GRACE_PERIOD_INITIAL_WARNING" | "GUILD_DISCOVERY_GRACE_PERIOD_FINAL_WARNING" | "THREAD_CREATED" | "REPLY" | "APPLICATION_COMMAND" | "THREAD_STARTER_MESSAGE" | "GUILD_INVITE_REMINDER" | "CONTEXT_MENU_COMMAND" | "PING" | "MESSAGE_COMPONENT" | "APPLICATION_COMMAND_AUTOCOMPLETE"

Readonly Abstract user

user: User

User who triggered the request

alias

author

Accessors

author

  • get author(): User

  • Author of the request

    alias

    user

    Returns User

Generated using TypeDoc