Namespace gdprGuard

Index

Type Aliases

GdprManagerDecorator

GdprManagerDecorator: ((manager: GdprManager) => GdprManager)

Type declaration

- (manager: GdprManager): GdprManager
- A function used to decorate a GdprManager instance
  
  see
  https://en.wikipedia.org/wiki/Decorator_pattern
  
  Parameters
  - manager: GdprManager
  Returns GdprManager

GdprManagerEventHandler

GdprManagerEventHandler: (() => void)

Type declaration

- (): void
- Returns void

GdprManagerFactory

GdprManagerFactory: (() => Promise<GdprManager>)

Type declaration

- (): Promise<GdprManager>
- Factory function for a GdprManager
  
  export
  Returns Promise<GdprManager>

Functions

makeGuard

makeGuard(name: string, description: string, storage?: GdprStorage, required?: boolean, enabled?: null | boolean): GdprGuard

- Defined in node_modules/gdpr-guard/dist/GdprGuard.d.ts:102
Factory for creating a guard

Parameters
- name: string
  
  The unique name/identifier for this guard
- description: string
  
  The description of the guard
- Optional storage: GdprStorage
  
  Where the data will be stored
- Optional required: boolean
  
  Whether or not it is a required guard
- Optional enabled: null | boolean
  
  Whether or not it is currently enabled
Returns GdprGuard

visitGdpr

visitGdpr(guard: GdprGuard | GdprManager, visitor?: Partial<GdprVisitor>): void

- Defined in node_modules/gdpr-guard/dist/visitor.d.ts:31
Visit the GDPR structure

Parameters
- guard: GdprGuard | GdprManager
  
  The root of the GDPR structure to visit
- Optional visitor: Partial<GdprVisitor>
Returns void