@genesislcap/foundation-comms 14.302.0 → 14.302.1-alpha-945e484.0

package/docs/api/foundation-comms.networkmonitor.md

@@ -18,17 +18,103 @@ UIs can listen for 'system-health-changed' events and display visual overlays to
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [status](./foundation-comms.networkmonitor.status.md) |  | [SystemHealthStatus](./foundation-comms.systemhealthstatus.md) |  |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[status](./foundation-comms.networkmonitor.status.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[SystemHealthStatus](./foundation-comms.systemhealthstatus.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-|  Method | Description |
-|  --- | --- |
-|  [addResource(resource, metadata)](./foundation-comms.networkmonitor.addresource.md) |  |
-|  [create()](./foundation-comms.networkmonitor.create.md) |  |
-|  [destroy()](./foundation-comms.networkmonitor.destroy.md) |  |
-|  [removeResource(resource)](./foundation-comms.networkmonitor.removeresource.md) |  |
-|  [runAllChecks(source, force)](./foundation-comms.networkmonitor.runallchecks.md) |  |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[addResource(resource, metadata)](./foundation-comms.networkmonitor.addresource.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[create()](./foundation-comms.networkmonitor.create.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[destroy()](./foundation-comms.networkmonitor.destroy.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[removeResource(resource)](./foundation-comms.networkmonitor.removeresource.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[runAllChecks(source, force)](./foundation-comms.networkmonitor.runallchecks.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-comms.networkmonitor.removeresource.md

@@ -12,9 +12,39 @@ removeResource(resource: MonitoredResource): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  resource | [MonitoredResource](./foundation-comms.monitoredresource.md) | The resource reference. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+resource
+
+
+</td><td>
+
+[MonitoredResource](./foundation-comms.monitoredresource.md)
+
+
+</td><td>
+
+The resource reference.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-comms.networkmonitor.runallchecks.md

@@ -12,10 +12,55 @@ runAllChecks(source?: unknown, force?: boolean): Promise<void>;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  source | unknown | _(Optional)_ The source of the call, which may have been an event or scheduled interval. |
-|  force | boolean | _(Optional)_ A flag to bypass abort if already in progress logic. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+source
+
+
+</td><td>
+
+unknown
+
+
+</td><td>
+
+_(Optional)_ The source of the call, which may have been an event or scheduled interval.
+
+
+</td></tr>
+<tr><td>
+
+force
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_ A flag to bypass abort if already in progress logic.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-comms.networkmonitorconfig.md

@@ -14,17 +14,235 @@ export interface NetworkMonitorConfig
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [checkInterval?](./foundation-comms.networkmonitorconfig.checkinterval.md) |  | number | _(Optional)_ Periodic check internal in ms |
-|  [checkTimeout?](./foundation-comms.networkmonitorconfig.checktimeout.md) |  | number | _(Optional)_ Check timeout in ms |
-|  [documentEvents?](./foundation-comms.networkmonitorconfig.documentevents.md) |  | (keyof DocumentEventMap)\[\] | _(Optional)_ Document events that invoke checks |
-|  [eventEmitter?](./foundation-comms.networkmonitorconfig.eventemitter.md) |  | HTMLElement | _(Optional)_ The element to emit events from |
-|  [genesisConnectEvents?](./foundation-comms.networkmonitorconfig.genesisconnectevents.md) |  | [GenesisConnectEvents](./foundation-comms.genesisconnectevents.md)<!-- -->\[\] | _(Optional)_ Genesis connect events that invoke checks |
-|  [ignoredGenesisResources?](./foundation-comms.networkmonitorconfig.ignoredgenesisresources.md) |  | string\[\] | _(Optional)_ Ignored Genesis resources that will NOT invoke checks |
-|  [logLevel?](./foundation-comms.networkmonitorconfig.loglevel.md) |  | LogLevel | _(Optional)_ Default log level |
-|  [resourceChecks?](./foundation-comms.networkmonitorconfig.resourcechecks.md) |  | [MonitoredResourceChecks](./foundation-comms.monitoredresourcechecks.md) | _(Optional)_ Default resource checks function |
-|  [resourceDataLogon?](./foundation-comms.networkmonitorconfig.resourcedatalogon.md) |  | [MonitoredResourceDataLogon](./foundation-comms.monitoredresourcedatalogon.md) | _(Optional)_ Default resource data logon function |
-|  [startDelay?](./foundation-comms.networkmonitorconfig.startdelay.md) |  | number | _(Optional)_ Start delay in ms |
-|  [windowEvents?](./foundation-comms.networkmonitorconfig.windowevents.md) |  | (keyof WindowEventHandlersEventMap)\[\] | _(Optional)_ Window events that invoke checks |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[checkInterval?](./foundation-comms.networkmonitorconfig.checkinterval.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ Periodic check internal in ms
+
+
+</td></tr>
+<tr><td>
+
+[checkTimeout?](./foundation-comms.networkmonitorconfig.checktimeout.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ Check timeout in ms
+
+
+</td></tr>
+<tr><td>
+
+[documentEvents?](./foundation-comms.networkmonitorconfig.documentevents.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(keyof DocumentEventMap)\[\]
+
+
+</td><td>
+
+_(Optional)_ Document events that invoke checks
+
+
+</td></tr>
+<tr><td>
+
+[eventEmitter?](./foundation-comms.networkmonitorconfig.eventemitter.md)
+
+
+</td><td>
+
+
+</td><td>
+
+HTMLElement
+
+
+</td><td>
+
+_(Optional)_ The element to emit events from
+
+
+</td></tr>
+<tr><td>
+
+[genesisConnectEvents?](./foundation-comms.networkmonitorconfig.genesisconnectevents.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[GenesisConnectEvents](./foundation-comms.genesisconnectevents.md)<!-- -->\[\]
+
+
+</td><td>
+
+_(Optional)_ Genesis connect events that invoke checks
+
+
+</td></tr>
+<tr><td>
+
+[ignoredGenesisResources?](./foundation-comms.networkmonitorconfig.ignoredgenesisresources.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string\[\]
+
+
+</td><td>
+
+_(Optional)_ Ignored Genesis resources that will NOT invoke checks
+
+
+</td></tr>
+<tr><td>
+
+[logLevel?](./foundation-comms.networkmonitorconfig.loglevel.md)
+
+
+</td><td>
+
+
+</td><td>
+
+LogLevel
+
+
+</td><td>
+
+_(Optional)_ Default log level
+
+
+</td></tr>
+<tr><td>
+
+[resourceChecks?](./foundation-comms.networkmonitorconfig.resourcechecks.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[MonitoredResourceChecks](./foundation-comms.monitoredresourcechecks.md)
+
+
+</td><td>
+
+_(Optional)_ Default resource checks function
+
+
+</td></tr>
+<tr><td>
+
+[resourceDataLogon?](./foundation-comms.networkmonitorconfig.resourcedatalogon.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[MonitoredResourceDataLogon](./foundation-comms.monitoredresourcedatalogon.md)
+
+
+</td><td>
+
+_(Optional)_ Default resource data logon function
+
+
+</td></tr>
+<tr><td>
+
+[startDelay?](./foundation-comms.networkmonitorconfig.startdelay.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+_(Optional)_ Start delay in ms
+
+
+</td></tr>
+<tr><td>
+
+[windowEvents?](./foundation-comms.networkmonitorconfig.windowevents.md)
+
+
+</td><td>
+
+
+</td><td>
+
+(keyof WindowEventHandlersEventMap)\[\]
+
+
+</td><td>
+
+_(Optional)_ Window events that invoke checks
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-comms.normalisecriteria.md

@@ -14,10 +14,55 @@ export declare function normaliseCriteria(criteria: string, delimiter?: string):
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  criteria | string | Original concat criteria. |
-|  delimiter | string | _(Optional)_ Criteria delimiter. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+criteria
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+Original concat criteria.
+
+
+</td></tr>
+<tr><td>
+
+delimiter
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+_(Optional)_ Criteria delimiter.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-comms.resourcetype.md

@@ -14,9 +14,63 @@ export declare enum ResourceType
 
 ## Enumeration Members
 
-|  Member | Value | Description |
-|  --- | --- | --- |
-|  DATASERVER | <code>&quot;DATASERVER&quot;</code> |  |
-|  EVENT\_HANDLER | <code>&quot;EVENT_HANDLER&quot;</code> |  |
-|  REQUEST\_SERVER | <code>&quot;REQUEST_SERVER&quot;</code> |  |
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+DATASERVER
+
+
+</td><td>
+
+`"DATASERVER"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+EVENT\_HANDLER
+
+
+</td><td>
+
+`"EVENT_HANDLER"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+REQUEST\_SERVER
+
+
+</td><td>
+
+`"REQUEST_SERVER"`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-comms.retryinterval.md

@@ -2,7 +2,7 @@
 
 [Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [retryInterval](./foundation-comms.retryinterval.md)
 
-## retryInterval variable
+## retryInterval() function
 
 Generate reconnect interval based on scheduler
 
@@ -11,3 +11,62 @@ Generate reconnect interval based on scheduler
 ```typescript
 retryInterval: (reconnectOptions: SocketReconnectOptions, scheduler: SocketReconnectScheduler) => Observable<number>
 ```
+
+## Parameters
+
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+reconnectOptions
+
+
+</td><td>
+
+[SocketReconnectOptions](./foundation-comms.socketreconnectoptions.md)
+
+
+</td><td>
+
+[SocketReconnectOptions](./foundation-comms.socketreconnectoptions.md) options
+
+
+</td></tr>
+<tr><td>
+
+scheduler
+
+
+</td><td>
+
+[SocketReconnectScheduler](./foundation-comms.socketreconnectscheduler.md)
+
+
+</td><td>
+
+[SocketReconnectScheduler](./foundation-comms.socketreconnectscheduler.md) function
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+Observable&lt;number&gt;
+
+Observable<number>
+