Class ClaimSet

constructor

• new ClaimSet(claims): ClaimSet

• Parameters

  • claims: Claim[]

  Returns ClaimSet

Readonly claims

addIfNotChecked

• addIfNotChecked(claim): void

• if the given claim is not check in the claim set already it will add it

  Parameters

  • claim: string | IClaimData | Claim

  Returns void

addIfNotExact

• addIfNotExact(claim): void

• if the given claim is not hasExact in the claim set already it will add it

  Parameters

  • claim: string | IClaimData | Claim

  Returns void

check

• check(query): boolean

• returns true if any of the claims of the set returns true for the check() of the given query

  Parameters

  • query: string | IClaimData | Claim

    can be a string ("verb:resource" or "verb:*") or an object with verb and resource

  Returns boolean

  See

  Claim

clone

• clone(): ClaimSet

• returns a new ClaimSet with clones of the same claims

  Returns ClaimSet

directChildren

• directChildren(query): string[]

• collects from the claims of the set the result of directChild()

  Parameters

  • query: string | IClaimData | Claim

    can be a string ("verb:resource" or "verb:*") or an object with verb and resource

  Returns string[]

  See

  Claim

directDescendants

• directDescendants(query): string[]

• collects from the claims of the set the result of directDescendant()

  Parameters

  • query: string | IClaimData | Claim

    can be a string ("verb:resource" or "verb:*") or an object with verb and resource

  Returns string[]

  See

  Claim

freeze

• freeze(): void

• disallow any changes to the claim set. Resets the JSON string

  Returns void

hasExact

• hasExact(query): boolean

• returns true if any of the claims of the set returns true for the hasExact() of the given query

  Parameters

  • query: string | IClaimData | Claim

    can be a string ("verb:resource" or "verb:*") or an object with verb and resource

  Returns boolean

  See

  Claim

isFrozen

• isFrozen(): boolean

• returns True if the claim set does not allow any changes

  Returns boolean

toJSONString

• toJSONString(): string

• returns a string with the JSON representation of the claim set

  It is calculated only once and then memoized, but resets if the claimSet gets unfrozen

  Returns string

unfreeze

• unfreeze(): void

• allow changes to the claim set

  Returns void