CommandContext | discord-rose

Context holding all information about a ran command and utility functions

Hierarchy

CommandContext

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new CommandContext(opts: { args: string[]; command: CommandOptions; message: APIMessage; prefix: string; ran: string; worker: Worker }): CommandContext

- Defined in src/structures/CommandContext.ts:55
Parameters
- opts: { args: string[]; command: CommandOptions; message: APIMessage; prefix: string; ran: string; worker: Worker }
  - args: string[]
  - command: CommandOptions
  - message: APIMessage
  - prefix: string
  - ran: string
  - worker: Worker
Returns CommandContext

Properties

args

args: any[]

Command arguments

command

command: CommandOptions

Command options object

isInteraction

isInteraction: boolean = false

Whether or not a command is an interaction or not

message

message: APIMessage

Message which command was ran with

options

options: InteractionOptions = {}

Interaction options if ran as a slash command

prefix

prefix: string

Prefix command was ran with

ran

ran: string

Actual command that was ran (including possible aliases)

worker

worker: Worker

Worker

Accessors

author

get author(): APIUser

- Defined in src/structures/CommandContext.ts:69
Author of the message

Returns APIUser

channel

get channel(): undefined | APIChannel

- Defined in src/structures/CommandContext.ts:83
Channel where the message was sent

Returns undefined | APIChannel

embed

get embed(): Embed<APIMessage>

- Defined in src/structures/CommandContext.ts:192
Makes an embed to send

example

ctx.embed .title('Hello') .send()

Returns Embed<APIMessage>

guild

get guild(): undefined | CachedGuild

- Defined in src/structures/CommandContext.ts:76
Guild where the message was sent

Returns undefined | CachedGuild

interaction

get interaction(): Interaction

- Defined in src/structures/CommandContext.ts:23
Returns Interaction

me

get me(): APIGuildMember

- Defined in src/structures/CommandContext.ts:99
Bot's memeber within the guild

Returns APIGuildMember

member

get member(): APIGuildMember

- Defined in src/structures/CommandContext.ts:90
Member who sent the message

Returns APIGuildMember

Methods

delete

delete(): Promise<never>

- Defined in src/structures/CommandContext.ts:181
Deletes the invoking message

Returns Promise<never>

dm

dm(data: MessageTypes): Promise<APIMessage>

- Defined in src/structures/CommandContext.ts:157
Sends a message to the user who ran the command

Parameters
- data: MessageTypes
  
  Data for message
Returns Promise<APIMessage>

error

error(message: string | Promise<string>): Promise<void>

- Defined in src/structures/CommandContext.ts:145
Runs an error through sendback of commands.error

Parameters
- message: string | Promise<string>
  
  Message of error
Returns Promise<void>

hasPerms

hasPerms(perms: "createInvites" | "kick" | "ban" | "administrator" | "manageChannels" | "manageGuild" | "addReactions" | "auditLog" | "prioritySpeaker" | "stream" | "viewChannel" | "sendMessages" | "tts" | "manageMessages" | "embed" | "files" | "readHistory" | "mentionEveryone" | "externalEmojis" | "viewInsights" | "connect" | "speak" | "mute" | "deafen" | "move" | "useVoiceActivity" | "nickname" | "manageNicknames" | "manageRoles" | "webhooks" | "emojis" | "useSlashCommands" | "useApplicationCommands" | "requestToSpeak" | "manageThreads" | "usePublicThreads" | "usePrivateThreads" | "createPublicThreads" | "createPrivateThreads" | "useExternalStickers" | "sendMessagesInThreads"): boolean

- Defined in src/structures/CommandContext.ts:204
Whether or not the running user has a certain permission

Parameters
- perms: "createInvites" | "kick" | "ban" | "administrator" | "manageChannels" | "manageGuild" | "addReactions" | "auditLog" | "prioritySpeaker" | "stream" | "viewChannel" | "sendMessages" | "tts" | "manageMessages" | "embed" | "files" | "readHistory" | "mentionEveryone" | "externalEmojis" | "viewInsights" | "connect" | "speak" | "mute" | "deafen" | "move" | "useVoiceActivity" | "nickname" | "manageNicknames" | "manageRoles" | "webhooks" | "emojis" | "useSlashCommands" | "useApplicationCommands" | "requestToSpeak" | "manageThreads" | "usePublicThreads" | "usePrivateThreads" | "createPublicThreads" | "createPrivateThreads" | "useExternalStickers" | "sendMessagesInThreads"
  
  Permission to test
Returns boolean

myPerms

myPerms(perms: "createInvites" | "kick" | "ban" | "administrator" | "manageChannels" | "manageGuild" | "addReactions" | "auditLog" | "prioritySpeaker" | "stream" | "viewChannel" | "sendMessages" | "tts" | "manageMessages" | "embed" | "files" | "readHistory" | "mentionEveryone" | "externalEmojis" | "viewInsights" | "connect" | "speak" | "mute" | "deafen" | "move" | "useVoiceActivity" | "nickname" | "manageNicknames" | "manageRoles" | "webhooks" | "emojis" | "useSlashCommands" | "useApplicationCommands" | "requestToSpeak" | "manageThreads" | "usePublicThreads" | "usePrivateThreads" | "createPublicThreads" | "createPrivateThreads" | "useExternalStickers" | "sendMessagesInThreads"): boolean

- Defined in src/structures/CommandContext.ts:220
Whether or not the bot user has a certain permission

Parameters
- perms: "createInvites" | "kick" | "ban" | "administrator" | "manageChannels" | "manageGuild" | "addReactions" | "auditLog" | "prioritySpeaker" | "stream" | "viewChannel" | "sendMessages" | "tts" | "manageMessages" | "embed" | "files" | "readHistory" | "mentionEveryone" | "externalEmojis" | "viewInsights" | "connect" | "speak" | "mute" | "deafen" | "move" | "useVoiceActivity" | "nickname" | "manageNicknames" | "manageRoles" | "webhooks" | "emojis" | "useSlashCommands" | "useApplicationCommands" | "requestToSpeak" | "manageThreads" | "usePublicThreads" | "usePrivateThreads" | "createPublicThreads" | "createPrivateThreads" | "useExternalStickers" | "sendMessagesInThreads"
  
  Permission to test
Returns boolean

react

react(emoji: string): Promise<never>

- Defined in src/structures/CommandContext.ts:137
React to the invoking command message

Parameters
- emoji: string
  
  ID of custom emoji or unicode emoji
Returns Promise<never>

reply

reply(data: MessageTypes, mention?: boolean, ephermal?: boolean): Promise<APIMessage>

- Defined in src/structures/CommandContext.ts:110
Replies to the invoking message

Parameters
- data: MessageTypes
  
  Data for message
- mention: boolean = false
  
  Whether or not to mention the user in the reply (defaults to false)
- ephermal: boolean = false
  
  Whether to send the message so only the user can see (only available in slash commands)
Returns Promise<APIMessage>

Message sent

send

send(data: MessageTypes): Promise<APIMessage>

- Defined in src/structures/CommandContext.ts:129
Sends a message in the same channel as invoking message

Parameters
- data: MessageTypes
  
  Data for message
Returns Promise<APIMessage>

Message sent

sendFile

sendFile(file: { buffer: Buffer; name: string }, extra?: MessageTypes): Promise<APIMessage>

- Defined in src/structures/CommandContext.ts:167
Sends a file to the same channel

Parameters
- file: { buffer: Buffer; name: string }
  
  File buffer
  - buffer: Buffer
  - name: string
- Optional extra: MessageTypes
  
  Extra message options
Returns Promise<APIMessage>

typing

typing(): Promise<null>

- Defined in src/structures/CommandContext.ts:174
Starts typing in the channel

Returns Promise<null>

Generated using TypeDoc

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

opts: { args: string[]; command: CommandOptions; message: APIMessage; prefix: string; ran: string; worker: Worker }

args: string[]

command: CommandOptions

message: APIMessage

prefix: string

ran: string

worker: Worker

Returns CommandContext

Properties

args

command

isInteraction

message

options

prefix

ran

worker

Accessors

author

Returns APIUser

channel

Returns undefined | APIChannel

embed

Returns Embed<APIMessage>

guild

Returns undefined | CachedGuild

interaction

Returns Interaction

me

Returns APIGuildMember

member

Returns APIGuildMember

Methods

delete

Returns Promise<never>

dm

Parameters

data: MessageTypes

Returns Promise<APIMessage>

error

Parameters

message: string | Promise<string>

Returns Promise<void>

hasPerms

Parameters

Returns boolean

myPerms

Parameters

Returns boolean

react

Parameters

emoji: string

Returns Promise<never>

reply

Parameters

data: MessageTypes

mention: boolean = false

ephermal: boolean = false

Returns Promise<APIMessage>

send

Parameters

data: MessageTypes

Returns Promise<APIMessage>

sendFile

Parameters

file: { buffer: Buffer; name: string }

buffer: Buffer

name: string

Optional extra: MessageTypes

Returns Promise<APIMessage>

typing