Interface GdprGuard

Generic type representing a guard

Hierarchy

GdprRawInto<GdprGuardRaw>
- GdprGuard
  - GdprGuardCollection

Index

Properties

description enabled name required storage

Methods

disable disableForStorage enable enableForStorage isEnabled makeRequired raw toggle toggleForStorage

Properties

`Readonly` description

description: string

A description of what this guard does

enabled

enabled: boolean

Whether the guard is currently enabled

`Readonly` name

name: string

Unique name of this guard

required

required: boolean

Whether this guard is required

`Readonly` storage

storage: GdprStorage

Where this guard is stored

Methods

disable

disable(): GdprGuard
Disable this guard

Returns
this guard

Memberof
GdprGuard

Returns GdprGuard
- Defined in GdprGuard.ts:69

disableForStorage

disableForStorage(type: GdprStorage): GdprGuard
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 GdprGuard
- Defined in GdprGuard.ts:99

enable

enable(): GdprGuard
Enable this guard

Returns
this guard

Memberof
GdprGuard

Returns GdprGuard
- Defined in GdprGuard.ts:62

enableForStorage

enableForStorage(type: GdprStorage): GdprGuard
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 GdprGuard
- Defined in GdprGuard.ts:91

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
- Defined in GdprGuard.ts:55

makeRequired

makeRequired(): GdprGuard
Make this guard required

Returns
this guard

Memberof
GdprGuard

Returns GdprGuard
- Defined in GdprGuard.ts:83

raw

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

Returns GdprGuardRaw
Inherited from GdprRawInto.raw
- Defined in GdprGuard.ts:7

toggle

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

Returns
this guard

Memberof
GdprGuard

Returns GdprGuard
- Defined in GdprGuard.ts:76

toggleForStorage

toggleForStorage(type: GdprStorage): GdprGuard
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 GdprGuard
- Defined in GdprGuard.ts:107