Class GdprGuardGroup

A group of guards

Hierarchy

GdprGuardGroup

Implements

GdprGuardCollection
GdprRawInto<GdprGuardGroupRaw>

Index

Properties

`Protected` bindings

bindings: Map<string, GdprGuard>

Binding from guard name to guard

description

description: string

enabled

enabled: boolean

name

name: string

required

required: boolean

`Readonly` storage

storage: GdprStorage

Methods

addGuard

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

Returns

Memberof
GdprGuardGroup
Parameters
- guard: GdprGuard
Returns GdprGuardGroup
- Defined in node_modules/gdpr-guard/dist/GdprGuardGroup.d.ts:51

disable

disable(): GdprGuardGroup
Inherit Doc

Memberof
GdprGuardGroup

Returns

Returns GdprGuardGroup
Implementation of GdprGuardCollection.disable
- Defined in node_modules/gdpr-guard/dist/GdprGuardGroup.d.ts:80

disableForStorage

disableForStorage(type: GdprStorage): GdprGuardGroup
Inherit Doc

Memberof
GdprGuardGroup
Parameters
- type: GdprStorage
Returns GdprGuardGroup
Implementation of GdprGuardCollection.disableForStorage
- Defined in node_modules/gdpr-guard/dist/GdprGuardGroup.d.ts:106

enable

enable(): GdprGuardGroup
Inherit Doc

Memberof
GdprGuardGroup

Returns

Returns GdprGuardGroup
Implementation of GdprGuardCollection.enable
- Defined in node_modules/gdpr-guard/dist/GdprGuardGroup.d.ts:73

enableForStorage

enableForStorage(type: GdprStorage): GdprGuardGroup
Inherit Doc

Memberof
GdprGuardGroup
Parameters
- type: GdprStorage
Returns GdprGuardGroup
Implementation of GdprGuardCollection.enableForStorage
- Defined in node_modules/gdpr-guard/dist/GdprGuardGroup.d.ts:100

getGuard

getGuard(name: string): null | GdprGuard
Inherit Doc

Memberof
GdprGuardGroup
Parameters
- name: string
Returns null | GdprGuard
Implementation of GdprGuardCollection.getGuard
- Defined in node_modules/gdpr-guard/dist/GdprGuardGroup.d.ts:61

getGuards

getGuards(): GdprGuard[]
Returns GdprGuard[]
- Defined in node_modules/gdpr-guard/dist/GdprGuardGroup.d.ts:144

hasGuard

hasGuard(name: string): boolean
Inherit Doc

Memberof
GdprGuardGroup
Parameters
- name: string
Returns boolean
Implementation of GdprGuardCollection.hasGuard
- Defined in node_modules/gdpr-guard/dist/GdprGuardGroup.d.ts:56

isEnabled

isEnabled(name: string): boolean
Inherit Doc

Memberof
GdprGuardGroup
Parameters
- name: string
Returns boolean
Implementation of GdprGuardCollection.isEnabled
- Defined in node_modules/gdpr-guard/dist/GdprGuardGroup.d.ts:66

makeRequired

makeRequired(): GdprGuardGroup
Inherit Doc

Memberof
GdprGuardGroup

Returns

Returns GdprGuardGroup
Implementation of GdprGuardCollection.makeRequired
- Defined in node_modules/gdpr-guard/dist/GdprGuardGroup.d.ts:94

raw

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

Returns GdprGuardGroupRaw
Implementation of GdprRawInto.raw
- Defined in node_modules/gdpr-guard/dist/GdprGuardGroup.d.ts:118

toggle

toggle(): GdprGuardGroup
Inherit Doc

Memberof
GdprGuardGroup

Returns

Returns GdprGuardGroup
Implementation of GdprGuardCollection.toggle
- Defined in node_modules/gdpr-guard/dist/GdprGuardGroup.d.ts:87

toggleForStorage

toggleForStorage(type: GdprStorage): GdprGuardGroup
Inherit Doc

Memberof
GdprGuardGroup
Parameters
- type: GdprStorage
Returns GdprGuardGroup
Implementation of GdprGuardCollection.toggleForStorage
- Defined in node_modules/gdpr-guard/dist/GdprGuardGroup.d.ts:112

`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
  
  Whether or not the group is enabled by default
- Optional required: boolean
  
  Whether or not the entire group is required
Returns GdprGuardGroup
- Defined in node_modules/gdpr-guard/dist/GdprGuardGroup.d.ts:44