Class HelpCommand

Hierarchy

Maker
- HelpCommand

Index

Constructors

Properties

Methods

__getCommands__ __getContexts__ __getInteractions__ __start__ c codeblock getCommand getCommands getGroup getWalkCommands help sendCommandHelp sendEmptyHelp sendGroupHelp sendNotFound

Constructors

constructor

new HelpCommand(bot): HelpCommand
Parameters
- bot: Erine<ClientEvents>
Returns HelpCommand
Inherited from Maker.constructor
- Defined in src/classes/Maker.ts:8

Properties

Methods

getCommands

__getCommands__(): CommandObject[]
Returns CommandObject[]
Inherited from Maker.__getCommands__
- Defined in src/classes/Maker.ts:47

getContexts

__getContexts__(): ContextMenuObject[]
Returns ContextMenuObject[]
Inherited from Maker.__getContexts__
- Defined in src/classes/Maker.ts:53

getInteractions

__getInteractions__(): InteractionObject[]
Returns InteractionObject[]
Inherited from Maker.__getInteractions__
- Defined in src/classes/Maker.ts:50

start

__start__(): HelpCommand
Add all commands, interactions, events and context menus to the cache in this maker

Returns HelpCommand
Inherited from Maker.__start__
- Defined in src/classes/Maker.ts:17

c

c(q): string
Parameters
- q: string
Returns string
- Defined in src/classes/HelpCommand.ts:73

codeblock

codeblock(text): string
Parameters
- text: string
Returns string
- Defined in src/classes/HelpCommand.ts:26

getCommand

getCommand(q): null | CommandHelpingObject
Parameters
- q: string
Returns null | CommandHelpingObject
- Defined in src/classes/HelpCommand.ts:55

getCommands

getCommands(): CommandObject[]
Returns CommandObject[]
- Defined in src/classes/HelpCommand.ts:48

getGroup

getGroup(q): null | {
    aliases?: string[];
    description?: string;
    fallback?: boolean;
    name: string;
    subcommands: {
        aliases: string[];
        allowed: string[];
        description: string;
        full: string;
        group?: GroupObject;
        key: string;
        maker: any;
        name: string;
        params: TypeOfParam<ParamType>[];
        plugins: Plugin[];
        regexp: RegExp;
    }[];
    usage?: string;
}
Parameters
- q: string
Returns null | {
    aliases?: string[];
    description?: string;
    fallback?: boolean;
    name: string;
    subcommands: {
        aliases: string[];
        allowed: string[];
        description: string;
        full: string;
        group?: GroupObject;
        key: string;
        maker: any;
        name: string;
        params: TypeOfParam<ParamType>[];
        plugins: Plugin[];
        regexp: RegExp;
    }[];
    usage?: string;
}
- Defined in src/classes/HelpCommand.ts:65

getWalkCommands

getWalkCommands(): CommandHelpingObject[]
Returns CommandHelpingObject[]
- Defined in src/classes/HelpCommand.ts:51

help

help(ctx): Promise<any>
Parameters
- ctx: Context
Returns Promise<any>
- Defined in src/classes/HelpCommand.ts:15

sendCommandHelp

sendCommandHelp(ctx, command): Promise<void>
Parameters
- ctx: Context
- command: CommandHelpingObject
Returns Promise<void>
- Defined in src/classes/HelpCommand.ts:35

sendEmptyHelp

sendEmptyHelp(ctx): Promise<void>
Parameters
- ctx: Context
Returns Promise<void>
- Defined in src/classes/HelpCommand.ts:32

sendGroupHelp

sendGroupHelp(ctx, group): Promise<void>
Parameters
- ctx: Context
- group: GroupHelpingObject
Returns Promise<void>
- Defined in src/classes/HelpCommand.ts:42

sendNotFound

sendNotFound(ctx): Promise<void>
Parameters
- ctx: Context
Returns Promise<void>
- Defined in src/classes/HelpCommand.ts:29

Class HelpCommand

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

bot: Erine<ClientEvents>

Returns HelpCommand

Properties

bot

commands

contexts

interactions

Methods

__getCommands__

Returns CommandObject[]

__getContexts__

Returns ContextMenuObject[]

__getInteractions__

Returns InteractionObject[]

__start__

Returns HelpCommand

c

Parameters

q: string

Returns string

codeblock

Parameters

text: string

Returns string

getCommand

Parameters

q: string

Returns null | CommandHelpingObject

getCommands

Returns CommandObject[]

getGroup

Parameters

q: string

getWalkCommands

Returns CommandHelpingObject[]

help

Parameters

ctx: Context

Returns Promise<any>

sendCommandHelp

Parameters

ctx: Context

command: CommandHelpingObject

Returns Promise<void>

sendEmptyHelp

Parameters

ctx: Context

Returns Promise<void>

sendGroupHelp

Parameters

ctx: Context

group: GroupHelpingObject

Returns Promise<void>

sendNotFound

Parameters

ctx: Context

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

getCommands

getContexts

getInteractions

start