Klasa

Class: Resolver

Resolver

The base resolver class

new Resolver(client)

Parameters:
Name Type Description
client KlasaClient The Klasa Client
Since:
  • 0.0.1
Source:
lib/parsers/Resolver.js#L13

Properties

<static> regex :Object

Standard regular expressions for matching mentions and snowflake ids
Type:
  • Object
Properties:
Name Type Description
userOrMember RegExp Regex for users or members
channel RegExp Regex for channels
role RegExp Regex for roles
snowflake RegExp Regex for simple snowflake ids
Since:
  • 0.2.1
Source:
lib/parsers/Resolver.js#L178

Methods

<async> boolean(bool)

Resolve a Boolean instance.
Parameters:
Name Type Description
bool boolean | string The boolean to validate.
Since:
  • 0.0.1
Source:
lib/parsers/Resolver.js#L114
Returns:
Type
boolean

<async> channel(channel)

Resolve a Channel object by its instance of Channel, or by its Snowflake.
Parameters:
Name Type Description
channel Channel | Snowflake The channel to validate.
Since:
  • 0.0.1
Source:
lib/parsers/Resolver.js#L77
Returns:
Type
external:Channel

<async> float(number)

Resolve a Float.
Parameters:
Name Type Description
number string | number The float to validate.
Since:
  • 0.0.1
Source:
lib/parsers/Resolver.js#L149
Returns:
Type
number

<async> guild(guild)

Resolve a Guild object by its instance of Guild, or by its Snowflake.
Parameters:
Name Type Description
guild Guild | Snowflake The guild to validate/find.
Since:
  • 0.0.1
Source:
lib/parsers/Resolver.js#L89
Returns:
Type
external:Guild

<async> integer(integer)

Resolve an Integer.
Parameters:
Name Type Description
integer string | number The integer to validate.
Since:
  • 0.0.1
Source:
lib/parsers/Resolver.js#L137
Returns:
Type
number

<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
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
Source:
lib/parsers/Resolver.js#L29
Returns:
Type
external:Message

<async> role(role, guild)

Resolve a Role object by its instance of Role, or by its Snowflake.
Parameters:
Name Type Description
role Role | Snowflake The role to validate/find.
guild Guild The Guild object in which the role can be found.
Since:
  • 0.0.1
Source:
lib/parsers/Resolver.js#L102
Returns:
Type
external:Role

<async> string(string)

Resolve a String instance.
Parameters:
Name Type Description
string string The string to validate.
Since:
  • 0.0.1
Source:
lib/parsers/Resolver.js#L127
Returns:
Type
string

<async> url(hyperlink)

Resolve a hyperlink.
Parameters:
Name Type Description
hyperlink string The hyperlink to validate.
Since:
  • 0.0.1
Source:
lib/parsers/Resolver.js#L161
Returns:
Type
string

<async> user(user)

Resolve a User object by its instance of User, GuildMember, or by its Snowflake.
Parameters:
Name Type Description
user User | GuildMember | Message | Snowflake The user to validate.
Since:
  • 0.0.1
Source:
lib/parsers/Resolver.js#L40
Returns:
Type
external:User