bot-options.md

⚙ Bot options ⚙

Your bot can be customized if you want it to have a different behaviour. The options that it supports are:

• symbol
• contentProp
• messageEvent
• textFormatting
  • bold
  • italic
  • underline
  • strikethrough
  • code
• botMessages
  • error
  • emoji
    • list
    • error
    • question
  • suggestion
    • similarity
    • commandInfo
    • listMessage
    • helpInfo
  • help
    • name
    • message
    • specificHelpMessage
    • documentation
      • description
      • explanation
      • exampleInput
    • exampleText
    • withoutDocumentation
    • authData

symbol

The symbol that goes before the command name.

• Default value: !
• Value type: string

contentProp

The property of the Message object which contains its text.

• Default value: content
• Value type: string

messageEvent

The event emitted by the Client when the bot receives a message.

• Default value: message
• Value type: string

textFormatting

Symbols to format text.

• Value type: object
  • bold
  • italic
  • underline
  • strikethrough
  • code
• Value type of each prop: string

bold

Default value: *

italic

Default value: _

underline

Default value: empty

strikethrough

Default value: ~

code

Default value: ```

botMessages

Messages that the bot sends to the user for various situations.

• Value type: object
  • error
  • emoji
    • list
    • error
    • question
  • suggestion
    • similarity
    • commandInfo
    • listMessage
    • helpInfo
  • help
    • name
    • message
    • specificHelpMessage
    • documentation
      • description
      • explanation
      • exampleInput
    • exampleText
    • withoutDocumentation
    • authData

error

The message sent by the bot when there is an internal error.

• Default value: There was an error processing your command
• Value type: string

emoji

Emojis that go before messages for various situations.

• Value type: object
  • list
  • error
  • question

list

Emoji used to list commands. This is used in the help command, and when suggesting commands.

• Default value: ✅
• Value type: string

error

Emoji used when there is an internal error, or when a non existent command is sent by the user.

• Default value: ❌
• Value type: string

question

Emoji used for the help commands. It used on the general and specific help, and also when the user sends a non existent command.

• Default value: ❓
• Value type: string

suggestion

The message sent by the bot when the user sends a non existent command.

Value type: object

• similarity
• commandInfo
• listMessage
• helpInfo

similarity

Similarity rate used to suggest similar commands. How similar the command needs to be in order to be suggested.

• Default value: 0.5
• Value type: number from 0 (totally different) to 1 (equal)

commandInfo

Part of the message letting the user know that the command doesn't exist.

• Default value: (commandName) => `${commandName} doesn't exist`
• Value type: string | ((commandName: string) => string)

listMessage

Part of the message before listing similar commands in case there are.

• Default value: Maybe you meant

helpInfo

Part of the message letting the user know how to use the help command.

• Default value: (helpCommandName) => `Send ${helpCommandName} for more info`
• Value type: string | ((helpCommandName: string) => string)

help

Messages sent by the bot when the user sends the help command.

General help:

Specific command help:

Value type: object

• name
• message
• specificHelpMessage
• documentation
  • description
  • explanation
  • exampleInput
• exampleText
• withoutDocumentation
• authData

name

Name of the help command.

• Default value: help
• Value type: string

message

Part of the message before listing available commands.

• Default value: I can handle the following commands
• Value type: string

specificHelpMessage

Part of the general help message suggesting to use the specific help command.

• Default value: (specificHelpCommand) => `Send ${specificHelpCommand} for more information about commands`
• Value type: string | ((specificHelpCommand: string) => string)

documentation

Documentation object for the help command.

• Value type: object
  • description
  • explanation
  • exampleInput

description

Short description of the help command.

• Default value: Gives information about every command
• Value type: string

explanation

Detailed explanation of the help command.

• Default value: Use this command followed by another command's name to get more info about a it
• Value type: string

exampleInput

Example of the command usage.

• Default value: command name
• Value type: string

exampleText

Part of the message before showing the example of the command usage.

• Default value: For example
• Value type: string

withoutDocumentation

Message sent for the specific help when the command doesn't have documentation.

• Default value: This command doesn't have documentation
• Value type: string

authData

Data that will be passed to the auth method. Could be tokens, or whatever you need.

• Default value: null
• Value type: any