Class Role

color

colors

flags

guild

hoist

icon

id

managed

mentionable

name

permissions

rawPosition

tags

unicodeEmoji

createdAt

• get createdAt(): Date

  Returns Date

createdTimestamp

• get createdTimestamp(): number

  Returns number

editable

• get editable(): boolean

  Returns boolean

hexColor

• get hexColor(): `#${string}`

  Returns `#${string}`

members

• get members(): Collection<string, GuildMember>

  Returns Collection<string, GuildMember>

position

• get position(): number

  Returns number

comparePositionTo

• comparePositionTo(role: RoleResolvable): number

  Parameters

  • role: RoleResolvable

  Returns number

delete

• delete(reason?: string): Promise<Role>

  Parameters

  • Optionalreason: string

  Returns Promise<Role>

edit

• edit(options: RoleEditOptions): Promise<Role>

  Parameters

  • options: RoleEditOptions

  Returns Promise<Role>

equals

• equals(role: Role): boolean

  Parameters

  • role: Role

  Returns boolean

iconURL

• iconURL(options?: ImageURLOptions): null | string

  Parameters

  • Optionaloptions: ImageURLOptions

  Returns null | string

permissionsIn

• permissionsIn(
      channel: string | NonThreadGuildBasedChannel,
      checkAdmin?: boolean,
  ): Readonly<PermissionsBitField>

  Parameters

  • channel: string | NonThreadGuildBasedChannel
  • OptionalcheckAdmin: boolean

  Returns Readonly<PermissionsBitField>

setColor

• setColor(color: ColorResolvable, reason?: string): Promise<Role>

  Parameters

  • color: ColorResolvable
  • Optionalreason: string

  Returns Promise<Role>

  Deprecated

  Use Role.setColors instead.

setColors

• setColors(colors: RoleColorsResolvable, reason?: string): Promise<Role>

  Parameters

  • colors: RoleColorsResolvable
  • Optionalreason: string

  Returns Promise<Role>

setHoist

• setHoist(hoist?: boolean, reason?: string): Promise<Role>

  Parameters

  • Optionalhoist: boolean
  • Optionalreason: string

  Returns Promise<Role>

setIcon

• setIcon(
      icon:
          | null
          | string
          | Buffer
          | GuildEmoji
          | ReactionEmoji
          | ApplicationEmoji,
      reason?: string,
  ): Promise<Role>

  Parameters

  • icon: null | string | Buffer | GuildEmoji | ReactionEmoji | ApplicationEmoji
  • Optionalreason: string

  Returns Promise<Role>

setMentionable

• setMentionable(mentionable?: boolean, reason?: string): Promise<Role>

  Parameters

  • Optionalmentionable: boolean
  • Optionalreason: string

  Returns Promise<Role>

setName

• setName(name: string, reason?: string): Promise<Role>

  Parameters

  • name: string
  • Optionalreason: string

  Returns Promise<Role>

setPermissions

• setPermissions(
      permissions: PermissionResolvable,
      reason?: string,
  ): Promise<Role>

  Parameters

  • permissions: PermissionResolvable
  • Optionalreason: string

  Returns Promise<Role>

setPosition

• setPosition(position: number, options?: SetRolePositionOptions): Promise<Role>

  Parameters

  • position: number
  • Optionaloptions: SetRolePositionOptions

  Returns Promise<Role>

setUnicodeEmoji

• setUnicodeEmoji(unicodeEmoji: null | string, reason?: string): Promise<Role>

  Parameters

  • unicodeEmoji: null | string
  • Optionalreason: string

  Returns Promise<Role>

toJSON

• toJSON(): unknown

  Returns unknown

toString

• toString(): RoleMention

  Returns a string representation of an object.

  Returns RoleMention