import Command from 'discord-graf/src/commands/command.js'

public class | source

Command

A command that can be run in a bot

Static Method Summary

Static Public Methods
public static	isEnabled(settings: SettingStorage, guild: Guild, command: Command \| string): boolean Checks if a command is enabled on a guild
public static	setEnabled(settings: SettingStorage, guild: Guild \| string, command: Command \| string, enabled: boolean) Enables or disables a command on a guild

Constructor Summary

Public Constructor
public	constructor(bot: Bot, info: CommandInfo)

Member Summary

Public Members
public	aliases: string[]
public	argsCount: number
public	argsSingleQuotes: boolean
public	argsType: string
public	bot: Bot
public	defaultHandling: boolean
public	description: string
public	details: string
public	examples: string[]
public	guildOnly: boolean
public	memberName: string
public	module: string
public	name: string
public	patterns: RegExp[]
public	usage: string

Method Summary

Public Methods
public	hasPermission(guild: Guild, user: User): boolean Checks a user's permission on a guild
public	isEnabled(guild: Guild): boolean Checks if the command is enabled on a guild
public	isUsable(message: Message): boolean Checks if the command is usable for a message
public	run(message: Message, args: string[], fromPattern: boolean): Promise<CommandResult \| string[] \| string> Runs the command
public	setEnabled(guild: Guild \| string, enabled: boolean) Enables or disables the command on a guild

Static Public Methods

public static isEnabled(settings: SettingStorage, guild: Guild, command: Command | string): boolean source

Checks if a command is enabled on a guild

Params:

Name	Type	Attribute	Description
settings	SettingStorage		The setting storage to use
guild	Guild		The guild
command	Command \| string		The command or command name

Return:

boolean

Whether or not the command is enabled

See:

Command#isEnabled

public static setEnabled(settings: SettingStorage, guild: Guild | string, command: Command | string, enabled: boolean) source

Enables or disables a command on a guild

Params:

Name	Type	Attribute	Description
settings	SettingStorage		The setting storage to use
guild	Guild \| string		The guild or guild ID
command	Command \| string		The command or command name
enabled	boolean		Whether the command should be enabled or disabled

See:

Command#setEnabled

Public Constructors

public constructor(bot: Bot, info: CommandInfo) source

Params:

Name	Type	Attribute	Description
bot	Bot		The bot the command is for
info	CommandInfo		The command information

Public Members

public aliases: string[] source

See:

CommandInfo

public argsCount: number source

See:

CommandInfo

public argsSingleQuotes: boolean source

See:

CommandInfo

public argsType: string source

See:

CommandInfo

public bot: Bot source

public defaultHandling: boolean source

See:

CommandInfo

public description: string source

See:

CommandInfo

public details: string source

See:

CommandInfo

public examples: string[] source

See:

CommandInfo

public guildOnly: boolean source

See:

CommandInfo

public memberName: string source

See:

CommandInfo

public module: string source

See:

CommandInfo

public name: string source

See:

CommandInfo

public patterns: RegExp[] source

See:

CommandInfo

public usage: string source

See:

CommandInfo

Public Methods

public hasPermission(guild: Guild, user: User): boolean source

Checks a user's permission on a guild

Params:

Name	Type	Attribute	Description
guild	Guild		The guild to test the user's permission in
user	User		The user to test the permission of

Return:

boolean

Whether or not the user has permission to use the command in a guild

public isEnabled(guild: Guild): boolean source

Checks if the command is enabled on a guild

Params:

Name	Type	Attribute	Description
guild	Guild		The guild

Return:

boolean

Whether or not the command is enabled

See:

Command.isEnabled

public isUsable(message: Message): boolean source

Checks if the command is usable for a message

Params:

Name	Type	Attribute	Description
message	Message	nullable: true	The message

Return:

boolean

Whether or not the command is usable

public run(message: Message, args: string[], fromPattern: boolean): Promise<CommandResult | string[] | string> source

Runs the command

Params:

Name	Type	Attribute	Description
message	Message		The message the command is being run for
args	string[]		The arguments for the command, or the matches from a pattern
fromPattern	boolean		Whether or not the command is being run from a pattern match or not

Return:

Promise<CommandResult | string[] | string>

The result of running the command

public setEnabled(guild: Guild | string, enabled: boolean) source

Enables or disables the command on a guild

Params:

Name	Type	Attribute	Description
guild	Guild \| string		The guild or guild ID
enabled	boolean		Whether the command should be enabled or disabled

See:

Command.setEnabled