class InviteRole

extends

BaseRole
export class InviteRole extends BaseRole

Represents a role received from an invite

client
colors
createdAt
createdTimestamp
hexColor
icon
id
name
rawPosition
unicodeEmoji
iconURL
toJSON
toString
valueOf

readonly
client : Client<true>

The client that instantiated this

Inherited from: Base

colors : RoleColors

The colors of the role

Inherited from: BaseRole

readonly
createdAt : Date

The time the role was created at

Inherited from: BaseRole

readonly
createdTimestamp : number

The timestamp the role was created at

Inherited from: BaseRole

readonly
hexColor : HexColorString

The hexadecimal version of the role color, with a leading hashtag

Inherited from: BaseRole

icon : string | null

The icon hash of the role

Inherited from: BaseRole

id : Snowflake

The role's id (unique to the guild it is part of)

Inherited from: BaseRole

name : string

The name of the role

Inherited from: BaseRole

rawPosition : number

The raw position of the role from the API

Inherited from: BaseRole

unicodeEmoji : string | null

The unicode emoji for the role

Inherited from: BaseRole

iconURL(
options?: ImageURLOptions = {}
) : string | null

A link to the role's icon

Inherited from: BaseRole

toJSON() : unknown

Inherited from: BaseRole

toString() : RoleMention

When concatenated with a string, this automatically returns the role's mention instead of the Role object.

Examples:
// Logs: Role: <@&123456789012345678>
console.log(`Role: ${role}`);

Inherited from: BaseRole

valueOf() : string

Inherited from: Base