Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GdprGuard

Generic type representing a guard

Hierarchy

Index

Properties

Methods

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 this guard

    memberof

    GdprGuard

    Returns GdprGuard

    this guard

disableForStorage

  • Disable guards of the given type (this guard and sub-guards)

    memberof

    GdprGuard

    Parameters

    • type: GdprStorage

      The storage type to enable all guards for

    Returns GdprGuard

    this guard

enable

  • Enable this guard

    memberof

    GdprGuard

    Returns GdprGuard

    this guard

enableForStorage

  • Enable guards of the given type (this guard and sub-guards)

    memberof

    GdprGuard

    Parameters

    • type: GdprStorage

      The storage type to enable all guards for

    Returns GdprGuard

    this guard

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

makeRequired

  • Make this guard required

    memberof

    GdprGuard

    Returns GdprGuard

    this guard

raw

  • Raw/simple representation of this guard

    Returns GdprGuardRaw

toggle

  • Toggle the enabled state of this guard

    memberof

    GdprGuard

    Returns GdprGuard

    this guard

toggleForStorage

  • Toggle guards of the given type (this guard and sub-guards)

    memberof

    GdprGuard

    Parameters

    • type: GdprStorage

      The storage type to enable all guards for

    Returns GdprGuard

    this guard