Class UserPermissions

constructor

• new UserPermissions(bits?: UserPermissionsResolvable): UserPermissions

  Parameters

  • Optionalbits: UserPermissionsResolvable

  Returns UserPermissions

bitfield

Static ReadonlyFLAGS

self

• get self(): {
      FLAGS: Record<string, number>;
      resolve(bit: BitFieldResolvable): number;
      new (bits?: BitFieldResolvable): BitField;
  }

  Returns the class that this instance belongs to.

  Returns {
      FLAGS: Record<string, number>;
      resolve(bit: BitFieldResolvable): number;
      new (bits?: BitFieldResolvable): BitField;
  }

  The class of the bitfield.

[iterator]

• "[iterator]"(): Iterable<string>

  Returns Iterable<string>

add

• add(...bits: UserPermissionsResolvable[]): this

  Parameters

  • ...bits: UserPermissionsResolvable[]

  Returns this

any

• any(bit: UserPermissionsResolvable): boolean

  Checks if any of the bits in the bitfield are set.

  Parameters

  • bit: UserPermissionsResolvable

    The bitfield or array of bitfields to check.

  Returns boolean

  True if any bits are set, false otherwise.

freeze

• freeze(): Readonly<UserPermissions>

  Returns Readonly<UserPermissions>

has

• has(bit: UserPermissionsResolvable): boolean

  checks if a specific permission is set.

  Parameters

  • bit: UserPermissionsResolvable

  Returns boolean

remove

• remove(...bits: UserPermissionsResolvable[]): this

  Parameters

  • ...bits: UserPermissionsResolvable[]

  Returns this

serialize

• serialize(): Record<
      "ACCESS"
      | "VIEW_PROFILE"
      | "SEND_MESSAGES"
      | "INVITE",
      boolean,
  >

  Returns Record<"ACCESS" | "VIEW_PROFILE" | "SEND_MESSAGES" | "INVITE", boolean>

  A record of all flags and their boolean values indicating whether they are set.

toArray

• toArray(): string[]

  Returns an array of all the Permissions that are set in the bitfield.

  Returns string[]

  An array of flag names.

valueOf

• valueOf(): number

  Returns number

Staticresolve

• resolve(bit: UserPermissionsResolvable): number

  Resolves a bitfield or an array of bitfields into a single number.

  Parameters

  • bit: UserPermissionsResolvable

    The bitfield or array of bitfields to resolve.

  Returns number

  The resolved bitfield as a number.