src/rpiWebClient.interfaces.ts
Realtime Lens object used to configure storage (localstorage and cookie) lenses
Properties |
|
lookupKey |
lookupKey:
|
Type : string
|
The name of the cookie or localstorage item |
realtimeParameter |
realtimeParameter:
|
Type : LensParameter
|
The LensParameter settings for the Realtime Parameter |
retry |
retry:
|
Type : boolean
|
Flag to specify whether to attempt retries should the storage item not be found on page load. This option should be used if the storage item isn't guaranteed to be available on page load |
retryCount |
retryCount:
|
Type : number
|
Optional |
The maximum number of retry attempts to perform. Used when retry is true |
retryDelayMs |
retryDelayMs:
|
Type : number
|
Optional |
The number milliseconds to wait between retry attempts. Used when retry is true |
storageType |
storageType:
|
Type : string
|
The type of storage item to lookup |