Class LocalStorageMonitorRepository

A repository to persist a monitor in a localStorage like/compliant storage

Hierarchy

LocalStorageMonitorRepository

Implements

MonitorRepository

Index

Constructors

constructor

Methods

Constructors

constructor

new LocalStorageMonitorRepository(storage: LocalStorage, options?: Options): LocalStorageMonitorRepository

- Defined in packages/monitor/src/repositories/localStorageMonitorRepository.ts:30
Parameters
- storage: LocalStorage
  
  a localStorage compliant implementation Usually, you will use the browser localStorage, so
  
  new LocalStorageMonitorRepository(window.localStorage)
  
  would be your way to go
- Default value options: Options = DefaultOptions
  
  Additional options
Returns LocalStorageMonitorRepository

Methods

get

get(key: any): Promise<GenericMonitor | null>

Implementation of MonitorRepository.get
- Defined in packages/monitor/src/repositories/localStorageMonitorRepository.ts:50
Gets a specific monitor by key

note

The monitor will be deserialized and eventually started (see options)

Parameters
- key: any
  
  The identifier of the monitor
Returns Promise<GenericMonitor | null>

the monitor instance, or null if not found

getAll

getAll(): Promise<GenericMonitor[]>

Implementation of MonitorRepository.getAll
- Defined in packages/monitor/src/repositories/localStorageMonitorRepository.ts:61
Gets all stored monitors

note

The monitors will be deserialized and eventually started (see options)

Returns Promise<GenericMonitor[]>

the monitor instances

insert

insert(monitor: GenericMonitor): Promise<void>

Implementation of MonitorRepository.insert
- Defined in packages/monitor/src/repositories/localStorageMonitorRepository.ts:76
Inserts/Serializes a monitor, if not exists already

throws

If monitor already stored

Parameters
- monitor: GenericMonitor
  
  The monitor instance
Returns Promise<void>

remove

remove(key: any): Promise<void>

Implementation of MonitorRepository.remove
- Defined in packages/monitor/src/repositories/localStorageMonitorRepository.ts:89
Removes a monitor

note

If no monitor with given key is stored, the method does nothing

Parameters
- key: any
  
  The monitors key
Returns Promise<void>