Class Grant<Sub, Act, Obj>

Type Parameters

Sub = string
Act = string
Obj = string

Index

Constructors

Properties

options present

Accessors

Methods

delete exists field filter has location notations scopes subjects time update

Constructors

constructor

new Grant<Sub, Act, Obj>(policies?, options?): Grant<Sub, Act, Obj>
Type Parameters
- Sub = string
- Act = string
- Obj = string
Parameters
- Optional policies: Policy<Sub, Act, Obj>[]
- Optional options: ControlOptions
Returns Grant<Sub, Act, Obj>
- Defined in classes/grant.class.ts:24

Properties

`Protected` `Readonly` options

options: ControlOptions = {}

`Protected` present

present: Record<string, Policy<Sub, Act, Obj>> = {}

Accessors

policies

get policies(): Policy<Sub, Act, Obj>[]
Returns Policy<Sub, Act, Obj>[]
- Defined in classes/grant.class.ts:38
set policies(policies): void
Parameters
- policies: Policy<Sub, Act, Obj>[]
Returns void
- Defined in classes/grant.class.ts:32

Methods

delete

delete(policy): boolean
Parameters
- policy: Policy<Sub, Act, Obj>
Returns boolean
- Defined in classes/grant.class.ts:55

exists

exists(policy): boolean
Parameters
- policy: Policy<Sub, Act, Obj>
Returns boolean
- Defined in classes/grant.class.ts:51

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>
- Defined in classes/grant.class.ts:151

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>
- Defined in classes/grant.class.ts:170

has

has(cKey): boolean
Parameters
- cKey: CacheKey<Sub, Act, Obj>
Returns boolean
- Defined in classes/grant.class.ts:59

location

location(ip, cKey?): boolean
Parameters
- ip: string
- Optional cKey: CacheKey<Sub, Act, Obj>
Returns boolean
- Defined in classes/grant.class.ts:122

`Protected` notations

notations(policies, data, type, cKey?): Promise<string[][]>
Parameters
- policies: Policy<Sub, Act, Obj>[]
- data: any
- type: "filter" | "field"
- Optional cKey: CacheKey<Sub, Act, Obj> | ((data) => CacheKey<Sub, Act, Obj> | Promise<CacheKey<Sub, Act, Obj>>)
Returns Promise<string[][]>
- Defined in classes/grant.class.ts:189

scopes

scopes<S>(prop, cKey?): S[]
Type Parameters
- S = string
Parameters
- prop: PropType
- Optional cKey: CacheKey<Sub, Act, Obj>
Returns S[]
- Defined in classes/grant.class.ts:68

subjects

subjects(cKey?): Sub[]
Parameters
- Optional cKey: CacheKey<Sub, Act, Obj>
Returns Sub[]
- Defined in classes/grant.class.ts:86

time

time(options?, cKey?): boolean
Parameters
- Optional options: TimeOptions
- Optional cKey: CacheKey<Sub, Act, Obj>
Returns boolean
- Defined in classes/grant.class.ts:100

update

update(policy): void
Parameters
- policy: Policy<Sub, Act, Obj>
Returns void
- Defined in classes/grant.class.ts:42

Generated using TypeDoc