Skip to main content
Version: 1.x

MessageCommandOptions

MessageCommandOptions​

commandkitMessageCommandParser.ts

Provides typed access to message command options with methods similar to Discord.js interaction options.

Signature
class MessageCommandOptions {
    constructor(parser: MessageCommandParser)
    getMember(name: string) => GuildMember | null;
    getMember(name: string, required: true) => GuildMember;
    getMember(name: string, required:  = false) => ;
    getAttachment(name: string) => Attachment | null;
    getAttachment(name: string, required: true) => Attachment;
    getAttachment(name: string, required:  = false) => ;
    getBoolean(name: string) => boolean | null;
    getBoolean(name: string, required: true) => boolean;
    getBoolean(name: string, required:  = false) => ;
    getNumber(name: string) => number | null;
    getNumber(name: string, required: true) => number;
    getNumber(name: string, required:  = false) => ;
    getString(name: string) => string | null;
    getString(name: string, required: true) => string;
    getString(name: string, required:  = false) => ;
    getInteger(name: string) => number | null;
    getInteger(name: string, required: true) => number;
    getInteger(name: string, required:  = false) => ;
    getUser(name: string) => User | null;
    getUser(name: string, required: true) => User;
    getUser(name: string, required:  = false) => ;
    getChannel(name: string) => Channel | null;
    getChannel(name: string, required: true) => Channel;
    getChannel(name: string, required:  = false) => ;
    getRole(name: string) => Role | null;
    getRole(name: string, required: true) => Role;
    getRole(name: string, required:  = false) => ;
    getMentionable(name: string) => NonNullable<CommandInteractionOption['member' | 'role' | 'user']> | null;
    getMentionable(name: string, required: true) => NonNullable<CommandInteractionOption['member' | 'role' | 'user']>;
    getMentionable(name: string, required:  = false) => NonNullable<CommandInteractionOption['member' | 'role' | 'user']> | null;
    getSubcommand() => string | null;
    getSubcommand(required: true) => string;
    getSubcommand(required:  = false) => ;
    getSubcommandGroup() => string | null;
    getSubcommandGroup(required: true) => string;
    getSubcommandGroup(required:  = false) => ;
}

constructor​

method
(parser: MessageCommandParser) => MessageCommandOptions

Creates a new message command options instance.

getMember​

method
(name: string) => GuildMember | null

Gets a guild member from the command options.

getMember​

method
(name: string, required: true) => GuildMember

getMember​

method
(name: string, required: = false) =>

getAttachment​

method
(name: string) => Attachment | null

Gets an attachment from the command options.

getAttachment​

method
(name: string, required: true) => Attachment

getAttachment​

method
(name: string, required: = false) =>

getBoolean​

method
(name: string) => boolean | null

Gets a boolean value from the command options.

getBoolean​

method
(name: string, required: true) => boolean

getBoolean​

method
(name: string, required: = false) =>

getNumber​

method
(name: string) => number | null

Gets a number value from the command options.

getNumber​

method
(name: string, required: true) => number

getNumber​

method
(name: string, required: = false) =>

getString​

method
(name: string) => string | null

Gets a string value from the command options.

getString​

method
(name: string, required: true) => string

getString​

method
(name: string, required: = false) =>

getInteger​

method
(name: string) => number | null

Gets an integer value from the command options.

getInteger​

method
(name: string, required: true) => number

getInteger​

method
(name: string, required: = false) =>

getUser​

method
(name: string) => User | null

Gets a user from the command options.

getUser​

method
(name: string, required: true) => User

getUser​

method
(name: string, required: = false) =>

getChannel​

method
(name: string) => Channel | null

Gets a channel from the command options.

getChannel​

method
(name: string, required: true) => Channel

getChannel​

method
(name: string, required: = false) =>

getRole​

method
(name: string) => Role | null

Gets a role from the command options.

getRole​

method
(name: string, required: true) => Role

getRole​

method
(name: string, required: = false) =>

getMentionable​

method
(name: string) => NonNullable<CommandInteractionOption['member' | 'role' | 'user']> | null

Gets a mentionable (user, member, or role) from the command options.

getMentionable​

method
(name: string, required: true) => NonNullable<CommandInteractionOption['member' | 'role' | 'user']>

getMentionable​

method
(name: string, required: = false) => NonNullable<CommandInteractionOption['member' | 'role' | 'user']> | null

getSubcommand​

method
() => string | null

Gets the subcommand name from the command.

getSubcommand​

method
(required: true) => string

getSubcommand​

method
(required: = false) =>

getSubcommandGroup​

method
() => string | null

Gets the subcommand group name from the command.

getSubcommandGroup​

method
(required: true) => string

getSubcommandGroup​

method
(required: = false) =>