Class GdprGuardGroup

A group of guards

Hierarchy

GdprGuardGroup

Implements

Index

Properties

`Protected` bindings

bindings: Map<string, GdprGuard> = ...

Binding from guard name to guard

description

description: string = ""

enabled

enabled: boolean = false

name

name: string

required

required: boolean = false

`Readonly` storage

storage: GdprStorage = GdprStorage.None

Where this guard is stored

Methods

addGuard

addGuard(guard: GdprGuard): GdprGuardGroup
Add a guard to this group

Returns

Memberof
GdprGuardGroup
Parameters
- guard: GdprGuard
Returns GdprGuardGroup
- Defined in GdprGuardGroup.ts:58

disable

disable(): GdprGuardGroup
Disable this guard

Returns
this guard

Memberof
GdprGuard

Returns GdprGuardGroup
Implementation of GdprGuardCollection.disable
- Defined in GdprGuardGroup.ts:121

disableForStorage

disableForStorage(type: GdprStorage): GdprGuardGroup
Disable guards of the given type (this guard and sub-guards)

Returns
this guard

Memberof
GdprGuard
Parameters
- type: GdprStorage
  
  The storage type to enable all guards for
Returns GdprGuardGroup
Implementation of GdprGuardCollection.disableForStorage
- Defined in GdprGuardGroup.ts:171

enable

enable(): GdprGuardGroup
Enable this guard

Returns
this guard

Memberof
GdprGuard

Returns GdprGuardGroup
Implementation of GdprGuardCollection.enable
- Defined in GdprGuardGroup.ts:107

enableForStorage

enableForStorage(type: GdprStorage): GdprGuardGroup
Enable guards of the given type (this guard and sub-guards)

Returns
this guard

Memberof
GdprGuard
Parameters
- type: GdprStorage
  
  The storage type to enable all guards for
Returns GdprGuardGroup
Implementation of GdprGuardCollection.enableForStorage
- Defined in GdprGuardGroup.ts:156

getGuard

getGuard(name: string): null | GdprGuard
Retrieve a guard from the collection

Memberof
GdprGuardCollection
Parameters
- name: string
  
  being the name of the guard to retrieve
Returns null | GdprGuard
Implementation of GdprGuardCollection.getGuard
- Defined in GdprGuardGroup.ts:77

getGuards

getGuards(): GdprGuard[]
Returns GdprGuard[]
- Defined in GdprGuardGroup.ts:266

hasGuard

hasGuard(name: string): boolean
Determine whether or not the collection has a given guard

Returns
TRUE if it is in its hierarchy, FALSE otherwise

Memberof
GdprGuardCollection
Parameters
- name: string
  
  The name of the guard to look for
Returns boolean
Implementation of GdprGuardCollection.hasGuard
- Defined in GdprGuardGroup.ts:67

isEnabled

isEnabled(name: string): boolean
Determine whether or not a guard is enabled

Memberof
GdprGuard
Parameters
- name: string
  
  The name of the guard to look for
Returns boolean
Implementation of GdprGuardCollection.isEnabled
- Defined in GdprGuardGroup.ts:90

makeRequired

makeRequired(): GdprGuardGroup
Make this guard required

Returns
this guard

Memberof
GdprGuard

Returns GdprGuardGroup
Implementation of GdprGuardCollection.makeRequired
- Defined in GdprGuardGroup.ts:145

raw

raw(): GdprGuardGroupRaw
Raw/simple representation of this guard

Returns GdprGuardGroupRaw
Implementation of GdprRawInto.raw
- Defined in GdprGuardGroup.ts:201

toggle

toggle(): GdprGuardGroup
Toggle the enabled state of this guard

Returns
this guard

Memberof
GdprGuard

Returns GdprGuardGroup
Implementation of GdprGuardCollection.toggle
- Defined in GdprGuardGroup.ts:135

toggleForStorage

toggleForStorage(type: GdprStorage): GdprGuardGroup
Toggle guards of the given type (this guard and sub-guards)

Returns
this guard

Memberof
GdprGuard
Parameters
- type: GdprStorage
  
  The storage type to enable all guards for
Returns GdprGuardGroup
Implementation of GdprGuardCollection.toggleForStorage
- Defined in GdprGuardGroup.ts:186

`Static` for

for(name: string, description??: string, enabled??: boolean, required??: boolean): GdprGuardGroup
Factory for creating a groupe

Static

Returns

Memberof
GdprGuardGroup
Parameters
- name: string
  
  The name of the group
- Optional description: string = ""
  
  The description of the group
- Optional enabled: boolean = false
  
  Whether or not the group is enabled by default
- Optional required: boolean = false
  
  Whether or not the entire group is required
Returns GdprGuardGroup
- Defined in GdprGuardGroup.ts:48