Class LocalStorageSavior

Handle saving/restoring/checking semantics

Interface

GdprSavior

Export

Hierarchy

GdprSaviorAdapter
- LocalStorageSavior

Index

Constructors

Properties

config decorator storage

Methods

check decorate exists restore restoreOrCreate store storeIfNotExists updateSharedManager

Constructors

constructor

new LocalStorageSavior(config?: LocalStorageConfig, storeFactory?: LocalStoreFactory, decorator?: undefined | GdprManagerDecorator): LocalStorageSavior
Parameters
- config: LocalStorageConfig = ...
- storeFactory: LocalStoreFactory = defaultStoreFactory
- decorator: undefined | GdprManagerDecorator = undefined
Returns LocalStorageSavior
Overrides GdprSaviorAdapter.constructor
- Defined in src/LocalStorageSavior.ts:8

Properties

`Protected` config

config: LocalStorageConfig = ...

`Protected` decorator

decorator: undefined | GdprManagerDecorator

`Protected` storage

storage: LocalStore

Methods

check

check(): Promise<void>
Check if there is an existing manager state (should rely on GdprSavior#exists)

Returns Promise<void>
Inherited from GdprSaviorAdapter.check
- Defined in node_modules/gdpr-guard/dist/serde/GdprSavior.d.ts:91

decorate

decorate(manager: GdprManager): GdprManager
Inherit Doc
Parameters
- manager: GdprManager
Returns GdprManager
Inherited from GdprSaviorAdapter.decorate
- Defined in node_modules/gdpr-guard/dist/serde/GdprSavior.d.ts:96

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>
Inherited from GdprSaviorAdapter.exists
- Defined in node_modules/gdpr-guard/dist/serde/GdprSavior.d.ts:76

restore

restore(shouldUpdate?: boolean): Promise<null | GdprManager>
Restore the manager (saved state)
Parameters
- shouldUpdate: boolean = true
  
  Whether it should update its savior internals (should default to true)
Returns Promise<null | GdprManager>
Overrides GdprSaviorAdapter.restore
- Defined in src/LocalStorageSavior.ts:27

restoreOrCreate

restoreOrCreate(factory: GdprManagerFactory): Promise<GdprManager>
Restore the manager or create one using the factory

Warning
This should not store/save the manager before returning it
Parameters
- factory: GdprManagerFactory
  
  Factory to create a manager (default manager state)
Returns Promise<GdprManager>
Inherited from GdprSaviorAdapter.restoreOrCreate
- Defined in node_modules/gdpr-guard/dist/serde/GdprSavior.d.ts:86

store

store(manager: GdprManagerRaw): Promise<boolean>
Overwrite the saved state of the manager
Parameters
- manager: GdprManagerRaw
  
  The manager to store (state to save)
Returns Promise<boolean>
Overrides GdprSaviorAdapter.store
- Defined in src/LocalStorageSavior.ts:78

storeIfNotExists

storeIfNotExists(manager: GdprManagerRaw): Promise<boolean>
Store the manager state if none is already save
Parameters
- manager: GdprManagerRaw
  
  The manager to store (state to save)
Returns Promise<boolean>
Inherited from GdprSaviorAdapter.storeIfNotExists
- Defined in node_modules/gdpr-guard/dist/serde/GdprSavior.d.ts:81

updateSharedManager

updateSharedManager(_manager: GdprManager): Promise<void>
Handle shared state updates
Parameters
- _manager: GdprManager
  
  The new manager to use
Returns Promise<void>
Overrides GdprSaviorAdapter.updateSharedManager
- Defined in src/LocalStorageSavior.ts:21