Class

Role

Guild role. Cached in guild.roles; permissions computed via member.permissions.

Extends Base

Constructor

new Role(client: Client, data: APIRole, guildId: string)

Name	Type	Description
clientread-only	`Client`	Parent client instance.
color	`number`	Role color (24-bit RGB).
createdAtread-only	`Date`	Date when this role was created, derived from its snowflake ID.
createdTimestampread-only	`number`	Unix timestamp (ms) when this role was created, derived from its snowflake ID.
guildIdread-only	`string`	Guild this role belongs to.
hoist	`boolean`	Whether this role is hoisted (shown separately in member list).
hoistPosition	`number \| null`	Hoist position (null = not hoisted).
idread-only	`string`	Role snowflake ID.
mentionable	`boolean`	Whether this role is mentionable.
name	`string`	Role name.
permissionsread-only	`PermissionsBitField`	Permissions bitfield (Administrator grants all permissions).
position	`number`	Role position (higher = above).
unicodeEmoji	`string \| null`	Unicode emoji for this role (null = none).

→ Promise<void>

DELETE role. Requires Manage Roles.

await role.delete();

options: RoleEditOptions → Promise<Role>

PATCH role. Requires Manage Roles.

await role.edit(options);

→ string

role.toString();