Class AccessControl<Sub, Act, Obj>

Type Parameters

Sub = string
Act = string
Obj = string

Index

Constructors

Properties

Methods

can clear delete exists setDriver update

Constructors

constructor

new AccessControl<Sub, Act, Obj>(policies?, options?): AccessControl<Sub, Act, Obj>
Type Parameters
- Sub = string
- Act = string
- Obj = string
Parameters
- Optional policies: Policy<Sub, Act, Obj>[]
- Optional options: AccessControlOptions<Sub, Act, Obj>
Returns AccessControl<Sub, Act, Obj>
- Defined in classes/acl.class.ts:23

Properties

`Protected` driver

driver: CacheInterface<Sub, Act, Obj>

`Protected` `Readonly` options

options: ControlOptions = {}

Methods

can

can(subjects, action, object, options?): Promise<Permission<Sub, Act, Obj>>
Parameters
- subjects: (PropValue & ControlOptions | Sub)[]
- action: PropValue & ControlOptions | Act
- object: PropValue & ControlOptions | Obj
- Optional options: CanOptions<Sub, Act, Obj>
Returns Promise<Permission<Sub, Act, Obj>>
- Defined in classes/acl.class.ts:59

clear

clear(): Promise<"OK">
Returns Promise<"OK">
- Defined in classes/acl.class.ts:38

delete

delete(policy): Promise<"OK">
Parameters
- policy: Policy<Sub, Act, Obj>
Returns Promise<"OK">
- Defined in classes/acl.class.ts:46

exists

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

`Protected` setDriver

setDriver(driver?): Promise<void>
Parameters
- Optional driver: "memory" | CacheInterface<Sub, Act, Obj> | (() => CacheInterface<Sub, Act, Obj> | Promise<CacheInterface<Sub, Act, Obj>>)
Returns Promise<void>
- Defined in classes/acl.class.ts:32

update

update(policy): Promise<"OK">
Parameters
- policy: Policy<Sub, Act, Obj>
Returns Promise<"OK">
- Defined in classes/acl.class.ts:50

Generated using TypeDoc