Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GdprSavior

Handle saving/restoring/checking semantics

interface

GdprSavior

export

Hierarchy

  • GdprSavior

Implemented by

Index

Properties

Methods

Properties

Optional decorate

decorate?: GdprManagerDecorator

Decorator API: Decorate the restored/created manager and use it

Methods

check

  • check(): Promise<void>

  • Check if there is an existing manager state (should rely on GdprSavior#exists)

    Returns Promise<void>

exists

  • exists(shouldUpdate?: boolean): Promise<boolean>

  • Determine whether there is already an existing manager (saved state)

    Parameters

    • Optional shouldUpdate: boolean

      Whether it should update its savior internals (should default to true)

    Returns Promise<boolean>

restore

  • restore(shouldUpdate?: boolean): Promise<null | GdprManager>

  • Restore the manager (saved state)

    Parameters

    • Optional shouldUpdate: boolean

      Whether it should update its savior internals (should default to true)

    Returns Promise<null | GdprManager>

restoreOrCreate

  • Restore the manager or create one using the factory

    warning

    This should not store/save the manager before returning it

    Parameters

    Returns Promise<GdprManager>

store

  • Overwrite the saved state of the manager

    Parameters

    Returns Promise<boolean>

storeIfNotExists

  • Store the manager state if none is already save

    Parameters

    Returns Promise<boolean>

updateSharedManager

  • updateSharedManager(manager: GdprManager): Promise<void>

  • Handle shared state updates

    Parameters

    Returns Promise<void>