elmabot - v0.5.5
Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns Help

Properties

Protected aliases

aliases: string | string[]

Protected commandName

commandName: string

Private Readonly commands

commands: object

Protected desc

desc: string = "Gives a list of commands or general information about them"

error

error: Error

errorString

errorString: string

Protected member

member: GuildMember

Protected message

message: Message

Protected needParamValues

needParamValues: boolean = true

Protected paramValues

paramValues: string[]

Protected params

params: string

Protected reply

reply: string | object

Protected replyTo

replyTo: boolean = false

Protected server

server: string

warning

warning: Error

Methods

echoCommand

  • echoCommand(command: any): Record<string, any> | string

  • Outputs a rich embed reply with the specifics of a command, or a negative confirmation if the reply doesn't exist

    Parameters

    • command: any

      the name of the command to look for

    Returns Record<string, any> | string

Protected echoList

  • echoList(): string

  • Outputs a list of available commands and aliases as a string

    Returns string

errorRespond

  • errorRespond(): void

  • Wrapper function which sets a generic error message to respond with and calls respond()

    Returns void

exec

  • exec(): Promise<boolean>

  • Returns Promise<boolean>

Protected getParams

  • getParams(): string[]

  • Gets an an array with all the parameters passed to a command

    Returns string[]

    string[]

respond

  • respond(): void

  • A base function that returns whatever reply has been set by other base functions, the command object returns this response after the command has been successfully ran defaults to sending it as a normal message, but can send it as reply if replyTo is set to true

    Returns void

returnProperties

  • returnProperties(): { alias: string | string[]; desc: string; name: string; syntax: string }

  • Returns the commands properties, for use in the Help command

    Returns { alias: string | string[]; desc: string; name: string; syntax: string }

    object

    • alias: string | string[]
    • desc: string
    • name: string
    • syntax: string

run

  • run(message: Message): Promise<{}>

  • The meat of the object, this function is called by the commander object and instantiates the object proper with all required values, then runs the encompassing function and returns the resulting promise object

    Parameters

    • message: Message

    Returns Promise<{}>

Legend

  • Class
  • Constructor
  • Method
  • Variable
  • Function
  • Inherited property
  • Inherited method
  • Protected property
  • Protected method
  • Interface
  • Private property

Generated using TypeDoc