Class Permissions

constructor

• new Permissions(...permissions: Permission[]): Permissions

  Constructor

  Parameters

  • ...permissions: Permission[]

    Permission instances to create the Permissions instance from.

  Returns Permissions

Readonlymask

hasAll

• hasAll(...permissions: Permission[]): boolean

  Checks if mask has all of the specified permissions.

  Parameters

  • ...permissions: Permission[]

    Permissions to compare with mask.

  Returns boolean

  true if mask holds all of the specified permissions.

hasAny

• hasAny(...permissions: Permission[]): boolean

  Checks if mask has any of the specified permissions.

  Parameters

  • ...permissions: Permission[]

    Permissions to compare with mask.

  Returns boolean

  true if mask holds any of the specified permissions.

toJson

• toJson(): string

  Converts the Permission object to a JSON representation.

  Returns string

  The JSON representation of the Permission object.

toString

• toString(): string

  Converts to a human readable string.

  Returns string

  Human readable string.

StaticcopyToRef

• copyToRef<T extends Pick<BimChangeBase, "permissions">>(
      permissions: Permission | Permissions | { json: string },
      dst: T,
  ): T

  Copies the permissions defined by permissions to the dst.permissions property.

  Type Parameters

  • T extends Pick<BimChangeBase, "permissions">

  Parameters

  • permissions: Permission | Permissions | { json: string }

    Permission to copy to dst.permissions property.
  • dst: T

    Change to use.

  Returns T

  Reference to dst.

StaticfromJsonObject

• fromJsonObject(permission: string): Permissions

  Create a Permissions instance from a permission mask represented as a bigint string. This is how permissions are represented in JSON as it is not possible to send 64bit integers in JSON.

  Parameters

  • permission: string

    If a real bigint string then it is converted to a Permissions instance. If it is a falsy returns a Permissions instance without any permissions. If it is a truthy but not a bigint string then a exception is generated.

  Returns Permissions

  Permissions instance.

Staticjoin

• join(...permissions: (Permission | Permission[])[]): bigint

  Join one or more permissions into a single numeric permission mask. Permissions are bitwise OR:ed together.

  Parameters

  • ...permissions: (Permission | Permission[])[]

    Permissions to join.

  Returns bigint

  Numeric permission mask. Can be compared directly with mask. Can also be used in constructor of Permissions.

StatictoString

• toString(...permissions: Permission[]): string

  Converts a number of Permission instances into a human readable string.

  Parameters

  • ...permissions: Permission[]

    Permissions to convert.

  Returns string

  Human readable string.