Role

Package: @erinjs/core

Represents a role in a guild.

Constructor

Name	Type	Optional	Description
client	Client	No
data	APIRole	No
guildId	string	No	The guild this role belongs to

Properties

Name	Type	Readonly	Optional	Description
client	Client	Yes	No
color	number	No	No
guildId	string	Yes	No
hoist	boolean	No	No
hoistPosition	number | null	No	No	Separately sorted position for hoisted roles. Null if not set.
id	string	Yes	No
mentionable	boolean	No	No
name	string	No	No
permissions	PermissionsBitField	Yes	No
position	number	No	No
unicodeEmoji	string | null	No	No

Methods

delete() async

Delete this role. Requires Manage Roles permission.

Returns: Promise<void>

Parameters:

None

---

edit() async

Edit this role. Requires Manage Roles permission.

Returns: Promise<Role>

Parameters:

Name	Type	Optional	Description
options	any	No	Role updates (permissions accepts PermissionResolvable for convenience)

---

toString()

Returns a mention string (e.g. <@&123456>).

Returns: string

Parameters:

None