Class Role

constructor

• new Role(
      server: Server,
      data: {
          colour?: null | string;
          hoist?: boolean;
          name: string;
          permissions: { a: number; d: number };
          rank?: number;
      } & { id: string },
  ): Role

  Creates a new Role instance.

  Parameters

  • server: Server

    The server this role belongs to.
  • data: {
        colour?: null | string;
        hoist?: boolean;
        name: string;
        permissions: { a: number; d: number };
        rank?: number;
    } & { id: string }

    The raw data for the role from the API.

    • Optionalcolour?: null | string

      Description

      Colour used for this role

      This can be any valid CSS colour

    • Optionalhoist?: boolean

      Description

      Whether this role should be shown separately on the member sidebar

    • name: string

      Description

      Role name

    • permissions: { a: number; d: number }

      Description

      Permissions available to this role

      • a: number

        Format: int64

        Description

        Allow bit flags

      • d: number

        Format: int64

        Description

        Disallow bit flags

    • Optionalrank?: number

      Format: int64

      Description

      Ranking of this role

      Default

      0
      Copy

    • id: string

  Returns Role

color

hoist

name

overwrite

rank

server

createdAt

• get createdAt(): Date

  Gets the date when the role was created.

  Returns Date

  The creation date of the role.

createdTimestamp

• get createdTimestamp(): number

  Gets the timestamp of when the role was created.

  Returns number

  The creation timestamp of the role in milliseconds.

permissions

• get permissions(): Overwrite

  Gets the permissions overwrite for the role.

  Returns Overwrite

  The permissions overwrite for the role.

delete

• delete(): Promise<void>

  Deletes the role from the server.

  Returns Promise<void>

  A promise that resolves when the role is deleted.

  Example

  await role.delete();
  console.log("Role deleted successfully.");
  Copy

edit

• edit(data: editableRole): Promise<Role>

  Parameters

  • data: editableRole

  Returns Promise<Role>

toString

• toString(): string

  Converts the role to a string representation.

  Returns string

  A string representation of the role in the format <@&roleId>.