Klasa

Class: SettingResolver

SettingResolver

The setting resolver

new SettingResolver()

Source:
lib/parsers/SettingResolver.js#L7

Extends

Methods

<static> maxOrMin(guild, value, min, max, name [, suffix])

Check if the input is valid with min and/or max values.
Parameters:
Name Type Argument Default Description
guild external:Guild The guild to resolve for
value number The value to check.
min number <nullable>
 Min value.
max number <nullable>
 Max value.
name string The name of the key being resolved
suffix string <optional>
 '' The suffix to apply to the error messages
Since:
  • 0.0.1
Source:
lib/parsers/SettingResolver.js#L214
Returns:
Type
boolean

<async> boolean(data, guild, name)

Resolves a boolean
Parameters:
Name Type Description
data any The data to resolve
guild external:Guild The guild to resolve for
name string The name of the key being resolved
Since:
  • 0.0.1
Overrides:
Source:
lib/parsers/SettingResolver.js#L101
Returns:
Type
boolean

<async> channel(data, guild, name)

Resolves a channel
Parameters:
Name Type Description
data any The data to resolve
guild external:Guild The guild to resolve for
name string The name of the key being resolved
Since:
  • 0.0.1
Overrides:
Source:
lib/parsers/SettingResolver.js#L31
Returns:
Type
external:Channel

<async> command(data, guild, name)

Resolves a command
Parameters:
Name Type Description
data any The data to resolve
guild external:Guild The guild to resolve for
name string The name of the key being resolved
Since:
  • 0.0.1
Source:
lib/parsers/SettingResolver.js#L182
Returns:
Type
Command

<async> float(data, guild, name, minMax)

Resolves a float
Parameters:
Name Type Description
data any The data to resolve
guild external:Guild The guild to resolve for
name string The name of the key being resolved
minMax Object The minimum and maximum
Properties
Name Type Argument Description
min number <nullable>
 The minumum value
max number <nullable>
 The maximum value
Since:
  • 0.0.1
Overrides:
Source:
lib/parsers/SettingResolver.js#L153
Returns:
Type
number

<async> guild(data, guild, name)

Resolves a guild
Parameters:
Name Type Description
data any The data to resolve
guild external:Guild The guild to resolve for
name string The name of the key being resolved
Since:
  • 0.0.1
Overrides:
Source:
lib/parsers/SettingResolver.js#L73
Returns:
Type
external:Guild

<async> integer(data, guild, name, minMax)

Resolves a integer
Parameters:
Name Type Description
data any The data to resolve
guild external:Guild The guild to resolve for
name string The name of the key being resolved
minMax Object The minimum and maximum
Properties
Name Type Argument Description
min number <nullable>
 The minumum value
max number <nullable>
 The maximum value
Since:
  • 0.0.1
Overrides:
Source:
lib/parsers/SettingResolver.js#L135
Returns:
Type
number

<async> language(data, guild, name)

Resolves a language
Parameters:
Name Type Description
data any The data to resolve
guild external:Guild The guild to resolve for
name string The name of the key being resolved
Since:
  • 0.2.1
Source:
lib/parsers/SettingResolver.js#L196
Returns:
Type
Language

<async> member(member, guild)

Resolve a GuildMember object by its instance of GuildMember, User, or by its Snowflake.
Parameters:
Name Type Description
member GuildMember | User | Snowflake The number to validate.
guild Guild The Guild object in which the member can be found.
Since:
  • 0.0.1
Inherited From:
Source:
lib/parsers/Resolver.js#L59
Returns:
Type
external:GuildMember

<async> msg(message, channel)

Fetch a Message object by its Snowflake or instanceof Message.
Parameters:
Name Type Description
message Message | Snowflake The message snowflake to validate.
channel Channel The Channel object in which the message can be found.
Since:
  • 0.0.1
Inherited From:
Source:
lib/parsers/Resolver.js#L29
Returns:
Type
external:Message

<async> role(data, guild, name)

Resolves a role
Parameters:
Name Type Description
data any The data to resolve
guild external:Guild The guild to resolve for
name string The name of the key being resolved
Since:
  • 0.0.1
Overrides:
Source:
lib/parsers/SettingResolver.js#L87
Returns:
Type
external:Role

<async> string(data, guild, name, minMax)

Resolves a string
Parameters:
Name Type Description
data any The data to resolve
guild external:Guild The guild to resolve for
name string The name of the key being resolved
minMax Object The minimum and maximum
Properties
Name Type Argument Description
min number <nullable>
 The minumum value
max number <nullable>
 The maximum value
Since:
  • 0.0.1
Overrides:
Source:
lib/parsers/SettingResolver.js#L118
Returns:
Type
string

<async> textchannel(data, guild, name)

Resolves a TextChannel
Parameters:
Name Type Description
data any The data to resolve
guild external:Guild The guild to resolve for
name string The name of the key being resolved
Since:
  • 0.3.0
Source:
lib/parsers/SettingResolver.js#L45
Returns:
Type
external:Channel

<async> url(data, guild, name)

Resolves a hyperlink
Parameters:
Name Type Description
data any The data to resolve
guild external:Guild The guild to resolve for
name string The name of the key being resolved
Since:
  • 0.0.1
Overrides:
Source:
lib/parsers/SettingResolver.js#L168
Returns:
Type
string

<async> user(data, guild, name)

Resolves a user
Parameters:
Name Type Description
data any The data to resolve
guild external:Guild The guild to resolve for
name string The name of the key being resolved
Since:
  • 0.0.1
Overrides:
Source:
lib/parsers/SettingResolver.js#L17
Returns:
Type
external:User

<async> voicechannel(data, guild, name)

Resolves a VoiceChannel
Parameters:
Name Type Description
data any The data to resolve
guild external:Guild The guild to resolve for
name string The name of the key being resolved
Since:
  • 0.3.0
Source:
lib/parsers/SettingResolver.js#L59
Returns:
Type
external:Channel