Klasa

Class: ArgResolver

ArgResolver

The command argument resolver

new ArgResolver()

Source:
lib/parsers/ArgResolver.js#L7

Extends

Methods

<static> minOrMax(value, min, max, currentUsage, possible, repeat, msg, suffix)

Checks min and max values
Parameters:
Name Type Argument Description
value number The value to check against
min number <nullable>
 The minimum value
max number <nullable>
 The maxiumum value
currentUsage Object The current usage
possible number The id of the current possible usage
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
suffix string An error suffix
Since:
  • 0.0.1
Source:
lib/parsers/ArgResolver.js#L560
Returns:
Type
boolean

<async> bool(arg, currentUsage, possible, repeat, msg)

Resolves a boolean
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Source:
lib/parsers/ArgResolver.js#L364
Returns:
Type
boolean

boolean(arg, currentUsage, possible, repeat, msg)

Resolves a boolean
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Overrides:
Source:
lib/parsers/ArgResolver.js#L350
Returns:
Type
boolean

<async> channel(arg, currentUsage, possible, repeat, msg)

Resolves a channel
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Overrides:
Source:
lib/parsers/ArgResolver.js#L283
Returns:
Type
external:Channel

<async> cmd(arg, currentUsage, possible, repeat, msg)

Resolves a command
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Source:
lib/parsers/ArgResolver.js#L69
Returns:
Type
Command

<async> command(arg, currentUsage, possible, repeat, msg)

Resolves a command
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Source:
lib/parsers/ArgResolver.js#L55
Returns:
Type
Command

<async> event(arg, currentUsage, possible, repeat, msg)

Resolves an event
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Source:
lib/parsers/ArgResolver.js#L86
Returns:
Type
Event

<async> extendable(arg, currentUsage, possible, repeat, msg)

Resolves an extendable
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Source:
lib/parsers/ArgResolver.js#L103
Returns:
Type
Extendable

<async> finalizer(arg, currentUsage, possible, repeat, msg)

Resolves a finalizer
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Source:
lib/parsers/ArgResolver.js#L120
Returns:
Type
Finalizer

<async> float(arg, currentUsage, possible, repeat, msg)

Resolves a number
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Overrides:
Source:
lib/parsers/ArgResolver.js#L474
Returns:
Type
number

<async> guild(arg, currentUsage, possible, repeat, msg)

Resolves a guild
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Overrides:
Source:
lib/parsers/ArgResolver.js#L300
Returns:
Type
external:Guild

<async> inhibitor(arg, currentUsage, possible, repeat, msg)

Resolves a inhibitor
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Source:
lib/parsers/ArgResolver.js#L137
Returns:
Type
Inhibitor

<async> int(arg, currentUsage, possible, repeat, msg)

Resolves a integer
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Source:
lib/parsers/ArgResolver.js#L425
Returns:
Type
number

integer(arg, currentUsage, possible, repeat, msg)

Resolves a integer
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Overrides:
Source:
lib/parsers/ArgResolver.js#L411
Returns:
Type
number

<async> language(arg, currentUsage, possible, repeat, msg)

Resolves a language
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.2.1
Source:
lib/parsers/ArgResolver.js#L171
Returns:
Type
Language

<async> literal(arg, currentUsage, possible, repeat, msg)

Resolves a literal
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Source:
lib/parsers/ArgResolver.js#L334
Returns:
Type
string

<async> member(arg, currentUsage, possible, repeat, msg)

Resolves a member
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Overrides:
Source:
lib/parsers/ArgResolver.js#L266
Returns:
Type
external:GuildMember

mention(arg, currentUsage, possible, repeat, msg)

Resolves a user
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Source:
lib/parsers/ArgResolver.js#L235
Returns:
Type
external:User

message(arg, currentUsage, possible, repeat, msg)

Resolves a message
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Source:
lib/parsers/ArgResolver.js#L204
Returns:
Type
external:Message

<async> monitor(arg, currentUsage, possible, repeat, msg)

Resolves a monitor
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Source:
lib/parsers/ArgResolver.js#L154
Returns:
Type
Monitor

<async> msg(arg, currentUsage, possible, repeat, msg)

Resolves a message
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Overrides:
Source:
lib/parsers/ArgResolver.js#L218
Returns:
Type
external:Message

num(arg, currentUsage, possible, repeat, msg)

Resolves a number
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Source:
lib/parsers/ArgResolver.js#L446
Returns:
Type
number

number(arg, currentUsage, possible, repeat, msg)

Resolves a number
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Source:
lib/parsers/ArgResolver.js#L460
Returns:
Type
number

<async> piece(arg, currentUsage, possible, repeat, msg)

Resolves a piece
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.3.0
Source:
lib/parsers/ArgResolver.js#L19
Returns:
Type
Piece

<async> provider(arg, currentUsage, possible, repeat, msg)

Resolves a provider
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Source:
lib/parsers/ArgResolver.js#L187
Returns:
Type
Provider

<async> reg(arg, currentUsage, possible, repeat, msg)

Resolves an argument based on a regular expression
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.3.0
Source:
lib/parsers/ArgResolver.js#L495
Returns:
Type
string

regex(arg, currentUsage, possible, repeat, msg)

Resolves an argument based on a regular expression
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.3.0
Source:
lib/parsers/ArgResolver.js#L512
Returns:
Type
string

regexp(arg, currentUsage, possible, repeat, msg)

Resolves an argument based on a regular expression
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.3.0
Source:
lib/parsers/ArgResolver.js#L526
Returns:
Type
string

<async> role(arg, currentUsage, possible, repeat, msg)

Resolves a role
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Overrides:
Source:
lib/parsers/ArgResolver.js#L317
Returns:
Type
external:Role

<async> store(arg, currentUsage, possible, repeat, msg)

Resolves a store
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.3.0
Source:
lib/parsers/ArgResolver.js#L38
Returns:
Type
Store

<async> str(arg, currentUsage, possible, repeat, msg)

Resolves a string
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Source:
lib/parsers/ArgResolver.js#L395
Returns:
Type
string

string(arg, currentUsage, possible, repeat, msg)

Resolves a string
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Overrides:
Source:
lib/parsers/ArgResolver.js#L381
Returns:
Type
string

<async> url(arg, currentUsage, possible, repeat, msg)

Resolves a hyperlink
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Overrides:
Source:
lib/parsers/ArgResolver.js#L540
Returns:
Type
string

<async> user(arg, currentUsage, possible, repeat, msg)

Resolves a user
Parameters:
Name Type Description
arg string This arg
currentUsage Object This current usage
possible number This possible usage id
repeat boolean If it is a looping/repeating arg
msg external:Message The message that triggered the command
Since:
  • 0.0.1
Overrides:
Source:
lib/parsers/ArgResolver.js#L249
Returns:
Type
external:User