Class Rule<ROLE, RESOURCE>

constructor

• new Rule<ROLE, RESOURCE>(type, privileges, assertion?): Rule<ROLE, RESOURCE>

• Type Parameters

  • ROLE extends Role = Role
  • RESOURCE extends Resource = Resource

  Parameters

  • type: Type
  • privileges: null | ReadonlySet<string>
  • Optionalassertion: Assertion<ROLE, RESOURCE>

  Returns Rule<ROLE, RESOURCE>

Optional Readonlyassertion

Readonlyprivileges

Readonlytype

match

• match(hrbac, role, resource, privilege): Promise<boolean>

• Parameters

  • hrbac: HRBAC
  • role: ROLE
  • resource: RESOURCE
  • privilege: null | string

  Returns Promise<boolean>

toJSON

• toJSON(): SerializedRule

• Returns SerializedRule

StaticfromJSON

• fromJSON(json): Rule<Role, Resource>

• Parameters

  • json: unknown

  Returns Rule<Role, Resource>