Class Claim

constructor

• new Claim(__namedParameters): Claim

• Parameters

  • __namedParameters: IClaimData

  Returns Claim

Readonly resource

Readonly verb

check

• check(query): boolean

• returns true if this claim includes the given query

  Parameters

  • query: string | IClaimData

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

  Returns boolean

clone

• clone(): Claim

• returns a new Claim with the same data

  Returns Claim

directChild

• directChild(query): null | string

• given a query, if this claim is a direct child of that query, it will return the immediate child part. Otherwise it returns null

  e.g.

  const claim = buildClaim("read:what.some.stuff");
  claim.directChild("admin:*") // => null
  claim.directChild("read:*") // => null
  claim.directChild("read:what") // => null
  claim.directChild("read:what.some") // => "stuff"
  claim.directChild("read:what.some.stuff") // => null
  claim.directChild("read:what.some.stuff.blah") // => null
  Copy

  Parameters

  • query: string | IClaimData

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

  Returns null | string

directDescendant

• directDescendant(query): null | string

• given a query, if this claim is a direct descendant of that query, it will return the immediate child part. Otherwise it returns null

  e.g.

  claim.directDescendant("admin:*") // => null
  claim.directDescendant("read:*") // => "what"
  claim.directDescendant("read:what") // => "some"
  claim.directDescendant("read:what.some") // => "stuff"
  claim.directDescendant("read:what.some.stuff") // => null
  claim.directDescendant("read:what.some.stuff.blah") // => null
  Copy

  Parameters

  • query: string | IClaimData

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

  Returns null | string

hasVerb

• hasVerb(verb): boolean

• true if the given verb is the same as the claim's

  Parameters

  • verb: string

  Returns boolean

isDirectChild

• isDirectChild(query): boolean

• return true if directChild() does not return null

  Parameters

  • query: string | IClaimData

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

  Returns boolean

  See

  directChild

isDirectDescendant

• isDirectDescendant(query): boolean

• return true if isDirectDescendant() does not return null

  Parameters

  • query: string | IClaimData

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

  Returns boolean

  See

  isDirectDescendant

isExact

• isExact(query): boolean

• returns true if this claim represents exactly the same as the given query

  Parameters

  • query: string | IClaimData

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

  Returns boolean

isGlobal

• isGlobal(): boolean

• true if the claim has no resource (global verb). This means that it represents all resources for this verb

  Returns boolean

toString

• toString(): string

• returns verb:resource (if global, it will return verb:*)

  Returns string