Class Permission<Sub, Act, Obj>

constructor

• new Permission<Sub, Act, Obj>(granted, grant): Permission<Sub, Act, Obj>

• Type Parameters

  • Sub = string
  • Act = string
  • Obj = string

  Parameters

  • granted: boolean
  • grant: Grant<Sub, Act, Obj>

  Returns Permission<Sub, Act, Obj>

Readonly grant

Readonly granted

policies

• get policies(): Policy<Sub, Act, Obj>[]

• Returns Policy<Sub, Act, Obj>[]

field

• field<Data>(data, cKey?): Promise<Data>

• Type Parameters

  • Data = any

  Parameters

  • data: any
  • Optional cKey: CacheKey<Sub, Act, Obj> | ((data) => CacheKey<Sub, Act, Obj> | Promise<CacheKey<Sub, Act, Obj>>)

  Returns Promise<Data>

filter

• filter<Data>(data, cKey?): Promise<Data>

• Type Parameters

  • Data = any

  Parameters

  • data: any
  • Optional cKey: CacheKey<Sub, Act, Obj> | ((data) => CacheKey<Sub, Act, Obj> | Promise<CacheKey<Sub, Act, Obj>>)

  Returns Promise<Data>

has

• has(cKey): boolean

• Parameters

  • cKey: CacheKey<Sub, Act, Obj>

  Returns boolean

location

• location(ip, cKey?): boolean

• Parameters

  • ip: string
  • Optional cKey: CacheKey<Sub, Act, Obj>

  Returns boolean

scopes

• scopes<Scope>(prop, cKey?): Scope[]

• Type Parameters

  • Scope = string

  Parameters

  • prop: PropType
  • Optional cKey: CacheKey<Sub, Act, Obj>

  Returns Scope[]

subjects

• subjects(cKey?): Sub[]

• Parameters

  • Optional cKey: CacheKey<Sub, Act, Obj>

  Returns Sub[]

time

• time(options?, cKey?): boolean

• Parameters

  • Optional options: TimeOptions
  • Optional cKey: CacheKey<Sub, Act, Obj>

  Returns boolean

Static build

• build<Sub, Act, Obj>(granted, policies, options?): Permission<Sub, Act, Obj>

• Type Parameters

  • Sub = string
  • Act = string
  • Obj = string

  Parameters

  • granted: boolean
  • policies: Policy<Sub, Act, Obj>[]
  • Optional options: ControlOptions

  Returns Permission<Sub, Act, Obj>