ParsedUsage(client, command)

Converts usage strings into objects to compare against later

new ParsedUsage(client, command)
classes/parsedUsage.js, line 11

Parameters:
Name Type Description
client KomadaClient The Komada client
command Command The command this parsed usage is for

Members

readonly client :KomadaClient
classes/parsedUsage.js, line 12

The client this CommandMessage was created with.

commands :string
classes/parsedUsage.js, line 30

The compiled string for all names/aliases in a usage string

deliminatedUsage :string
classes/parsedUsage.js, line 36

The usage string re-deliminated with the usageDelim

names :Array.<string>
classes/parsedUsage.js, line 24

All names and aliases for the command

nearlyFullUsage :string
classes/parsedUsage.js, line 54

The concatenated string of this.commands and this.deliminatedUsage

parsedUsage :Array.<Object>
classes/parsedUsage.js, line 48

The usage object to compare against later

usageString :string
classes/parsedUsage.js, line 42

The usage string

Methods

fullUsage(msg) → {string}
classes/parsedUsage.js, line 62

Creates a full usage string including prefix and commands/aliases for documentation/help purposes
Parameters:
Name Type Description
msg external:Message a message to check to get the current prefix
Returns:
string