@cofo/framework / Exports / Command
# Class: Command
# Table of contents
# Constructors
# Properties
- aliases
- argsRequired
- botOwnerOnly
- client
- cooldown
- cooldownMessage
- customInteractionPreCondition
- customPrecondition
- defaultPermission
- deleteCommand
- description
- dmOnly
- guildOnly
- guildOwneronly
- name
- options
- slash
- usage
# Constructors
# constructor
• new Command(client, options)
Create a new command
since 1.0.0
# Parameters
| Name | Type |
|---|---|
client | CofoClient |
options | Object |
options.aliases? | any[] |
options.argsRequired? | boolean |
options.botOwnerOnly? | boolean |
options.cooldown? | number |
options.cooldownMessage? | string |
options.defaultPermission? | boolean |
options.deleteCommand? | boolean |
options.description? | string |
options.dmOnly? | boolean |
options.guildOnly? | boolean |
options.guildOwnerOnly? | boolean |
options.name | string |
options.options? | ApplicationCommandOptions[] |
options.slash? | boolean |
options.usage? | string |
options.customInteractionPreCondition? | (interaction: CommandInteraction<TextableChannel>) => boolean |
options.customPrecondition? | (message: Message<TextableChannel>) => boolean |
# Defined in
src/Structures/Command.ts:29
# Properties
# aliases
• Optional aliases: any[]
# Defined in
src/Structures/Command.ts:14
# argsRequired
• Optional argsRequired: boolean
# Defined in
src/Structures/Command.ts:16
# botOwnerOnly
• Optional botOwnerOnly: boolean
# Defined in
src/Structures/Command.ts:13
# client
• Private client: CofoClient
# Defined in
src/Structures/Command.ts:5
# cooldown
• Optional cooldown: number
# Defined in
src/Structures/Command.ts:9
# cooldownMessage
• Optional cooldownMessage: string
# Defined in
src/Structures/Command.ts:17
# customInteractionPreCondition
• Optional customInteractionPreCondition: (interaction: CommandInteraction<TextableChannel>) => boolean
# Type declaration
▸ (interaction): boolean
# Parameters
| Name | Type |
|---|---|
interaction | CommandInteraction<TextableChannel> |
# Returns
boolean
# Defined in
src/Structures/Command.ts:22
# customPrecondition
• Optional customPrecondition: (message: Message<TextableChannel>) => boolean
# Type declaration
▸ (message): boolean
# Parameters
| Name | Type |
|---|---|
message | Message<TextableChannel> |
# Returns
boolean
# Defined in
src/Structures/Command.ts:21
# defaultPermission
• Optional defaultPermission: boolean
# Defined in
src/Structures/Command.ts:19
# deleteCommand
• Optional deleteCommand: boolean
# Defined in
src/Structures/Command.ts:18
# description
• description: undefined | string
# Defined in
src/Structures/Command.ts:7
# dmOnly
• Optional dmOnly: boolean
# Defined in
src/Structures/Command.ts:11
# guildOnly
• Optional guildOnly: boolean
# Defined in
src/Structures/Command.ts:10
# guildOwneronly
• Optional guildOwneronly: boolean
# Defined in
src/Structures/Command.ts:12
# name
• name: string
# Defined in
src/Structures/Command.ts:6
# options
• Optional options: ApplicationCommandOptions[]
# Defined in
src/Structures/Command.ts:8
# slash
• Optional slash: boolean
# Defined in
src/Structures/Command.ts:20
# usage
• Optional usage: string
# Defined in
src/Structures/Command.ts:15