@genesislcap/foundation-comms 14.167.3-alpha-b40d1e5.0 → 14.167.3-alpha-69ba23f.0

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

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitor](./foundation-comms.networkmonitor.md) &gt; [destroy](./foundation-comms.networkmonitor.destroy.md)
-
-## NetworkMonitor.destroy() method
-
-**Signature:**
-
-```typescript
-destroy(): void;
-```
-**Returns:**
-
-void
-

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

@@ -1,34 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitor](./foundation-comms.networkmonitor.md)
-
-## NetworkMonitor interface
-
-`NetworkMonitor` monitors network and resource availability and health.
-
-**Signature:**
-
-```typescript
-export interface NetworkMonitor 
-```
-
-## Remarks
-
-UIs can listen for 'system-health-changed' events and display visual overlays to communicate status to the user.
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [status](./foundation-comms.networkmonitor.status.md) |  | [SystemHealthStatus](./foundation-comms.systemhealthstatus.md) |  |
-
-## 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) |  |
-

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

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitor](./foundation-comms.networkmonitor.md) &gt; [removeResource](./foundation-comms.networkmonitor.removeresource.md)
-
-## NetworkMonitor.removeResource() method
-
-**Signature:**
-
-```typescript
-removeResource(resource: MonitoredResource): void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  resource | [MonitoredResource](./foundation-comms.monitoredresource.md) | The resource reference. |
-
-**Returns:**
-
-void
-

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

@@ -1,23 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitor](./foundation-comms.networkmonitor.md) &gt; [runAllChecks](./foundation-comms.networkmonitor.runallchecks.md)
-
-## NetworkMonitor.runAllChecks() method
-
-**Signature:**
-
-```typescript
-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. |
-
-**Returns:**
-
-Promise&lt;void&gt;
-

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

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitor](./foundation-comms.networkmonitor.md) &gt; [status](./foundation-comms.networkmonitor.status.md)
-
-## NetworkMonitor.status property
-
-**Signature:**
-
-```typescript
-status: SystemHealthStatus;
-```

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

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitorConfig](./foundation-comms.networkmonitorconfig.md) &gt; [checkInterval](./foundation-comms.networkmonitorconfig.checkinterval.md)
-
-## NetworkMonitorConfig.checkInterval property
-
-Periodic check internal in ms
-
-**Signature:**
-
-```typescript
-checkInterval?: number;
-```

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

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitorConfig](./foundation-comms.networkmonitorconfig.md) &gt; [checkTimeout](./foundation-comms.networkmonitorconfig.checktimeout.md)
-
-## NetworkMonitorConfig.checkTimeout property
-
-Check timeout in ms
-
-**Signature:**
-
-```typescript
-checkTimeout?: number;
-```

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

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitorConfig](./foundation-comms.networkmonitorconfig.md) &gt; [documentEvents](./foundation-comms.networkmonitorconfig.documentevents.md)
-
-## NetworkMonitorConfig.documentEvents property
-
-Document events that invoke checks
-
-**Signature:**
-
-```typescript
-documentEvents?: (keyof DocumentEventMap)[];
-```

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

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitorConfig](./foundation-comms.networkmonitorconfig.md) &gt; [eventEmitter](./foundation-comms.networkmonitorconfig.eventemitter.md)
-
-## NetworkMonitorConfig.eventEmitter property
-
-The element to emit events from
-
-**Signature:**
-
-```typescript
-eventEmitter?: HTMLElement;
-```

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

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitorConfig](./foundation-comms.networkmonitorconfig.md) &gt; [genesisConnectEvents](./foundation-comms.networkmonitorconfig.genesisconnectevents.md)
-
-## NetworkMonitorConfig.genesisConnectEvents property
-
-Genesis connect events that invoke checks
-
-**Signature:**
-
-```typescript
-genesisConnectEvents?: GenesisConnectEvents[];
-```

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

@@ -1,27 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitorConfig](./foundation-comms.networkmonitorconfig.md)
-
-## NetworkMonitorConfig interface
-
-NetworkMonitorConfig DI interface.
-
-**Signature:**
-
-```typescript
-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 |
-|  [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 |
-|  [windowEvents?](./foundation-comms.networkmonitorconfig.windowevents.md) |  | (keyof WindowEventHandlersEventMap)\[\] | _(Optional)_ Window events that invoke checks |
-

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

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitorConfig](./foundation-comms.networkmonitorconfig.md) &gt; [resourceChecks](./foundation-comms.networkmonitorconfig.resourcechecks.md)
-
-## NetworkMonitorConfig.resourceChecks property
-
-Default resource checks function
-
-**Signature:**
-
-```typescript
-resourceChecks?: MonitoredResourceChecks;
-```

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

@@ -1,18 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitorConfig](./foundation-comms.networkmonitorconfig.md) &gt; [resourceDataLogon](./foundation-comms.networkmonitorconfig.resourcedatalogon.md)
-
-## NetworkMonitorConfig.resourceDataLogon property
-
-Default resource data logon function
-
-**Signature:**
-
-```typescript
-resourceDataLogon?: MonitoredResourceDataLogon;
-```
-
-## Remarks
-
-Used to re-attempt data logon on an unhealthy data server
-

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

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [NetworkMonitorConfig](./foundation-comms.networkmonitorconfig.md) &gt; [windowEvents](./foundation-comms.networkmonitorconfig.windowevents.md)
-
-## NetworkMonitorConfig.windowEvents property
-
-Window events that invoke checks
-
-**Signature:**
-
-```typescript
-windowEvents?: (keyof WindowEventHandlersEventMap)[];
-```

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

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [ResourceHealth](./foundation-comms.resourcehealth.md)
-
-## ResourceHealth type
-
-ResourceHealth.
-
-**Signature:**
-
-```typescript
-export type ResourceHealth = MonitoredResourceChecksResult & {
-    name: string;
-    sourceRef: string;
-    lastError?: any;
-};
-```
-**References:** [MonitoredResourceChecksResult](./foundation-comms.monitoredresourcechecksresult.md)
-

package/docs/api/foundation-comms.serializedsocketstatus.closedclean.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [closedClean](./foundation-comms.serializedsocketstatus.closedclean.md)
-
-## SerializedSocketStatus.closedClean property
-
-**Signature:**
-
-```typescript
-readonly closedClean: boolean;
-```

package/docs/api/foundation-comms.serializedsocketstatus.closedcode.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [closedCode](./foundation-comms.serializedsocketstatus.closedcode.md)
-
-## SerializedSocketStatus.closedCode property
-
-**Signature:**
-
-```typescript
-readonly closedCode: number;
-```

package/docs/api/foundation-comms.serializedsocketstatus.closedreason.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [closedReason](./foundation-comms.serializedsocketstatus.closedreason.md)
-
-## SerializedSocketStatus.closedReason property
-
-**Signature:**
-
-```typescript
-readonly closedReason: string;
-```

package/docs/api/foundation-comms.serializedsocketstatus.hasvalidsession.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [hasValidSession](./foundation-comms.serializedsocketstatus.hasvalidsession.md)
-
-## SerializedSocketStatus.hasValidSession property
-
-**Signature:**
-
-```typescript
-hasValidSession: boolean;
-```

package/docs/api/foundation-comms.serializedsocketstatus.isconfigured.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [isConfigured](./foundation-comms.serializedsocketstatus.isconfigured.md)
-
-## SerializedSocketStatus.isConfigured property
-
-When the socket has been configured for use.
-
-**Signature:**
-
-```typescript
-isConfigured: boolean;
-```

package/docs/api/foundation-comms.serializedsocketstatus.isconnected.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [isConnected](./foundation-comms.serializedsocketstatus.isconnected.md)
-
-## SerializedSocketStatus.isConnected property
-
-**Signature:**
-
-```typescript
-isConnected: boolean;
-```

package/docs/api/foundation-comms.serializedsocketstatus.isconnecting.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [isConnecting](./foundation-comms.serializedsocketstatus.isconnecting.md)
-
-## SerializedSocketStatus.isConnecting property
-
-**Signature:**
-
-```typescript
-isConnecting: boolean;
-```

package/docs/api/foundation-comms.serializedsocketstatus.isdisconnected.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [isDisconnected](./foundation-comms.serializedsocketstatus.isdisconnected.md)
-
-## SerializedSocketStatus.isDisconnected property
-
-**Signature:**
-
-```typescript
-isDisconnected: boolean;
-```

package/docs/api/foundation-comms.serializedsocketstatus.isdisconnectedbyserver.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [isDisconnectedByServer](./foundation-comms.serializedsocketstatus.isdisconnectedbyserver.md)
-
-## SerializedSocketStatus.isDisconnectedByServer property
-
-**Signature:**
-
-```typescript
-isDisconnectedByServer: boolean;
-```

package/docs/api/foundation-comms.serializedsocketstatus.isreconnecting.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [isReconnecting](./foundation-comms.serializedsocketstatus.isreconnecting.md)
-
-## SerializedSocketStatus.isReconnecting property
-
-**Signature:**
-
-```typescript
-isReconnecting: boolean;
-```

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

@@ -1,30 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md)
-
-## SerializedSocketStatus interface
-
-`SerializedSocketStatus` provides the serialize state of the web socket.
-
-**Signature:**
-
-```typescript
-export interface SerializedSocketStatus 
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [closedClean](./foundation-comms.serializedsocketstatus.closedclean.md) | <code>readonly</code> | boolean |  |
-|  [closedCode](./foundation-comms.serializedsocketstatus.closedcode.md) | <code>readonly</code> | number |  |
-|  [closedReason](./foundation-comms.serializedsocketstatus.closedreason.md) | <code>readonly</code> | string |  |
-|  [hasValidSession](./foundation-comms.serializedsocketstatus.hasvalidsession.md) |  | boolean |  |
-|  [isConfigured](./foundation-comms.serializedsocketstatus.isconfigured.md) |  | boolean | When the socket has been configured for use. |
-|  [isConnected](./foundation-comms.serializedsocketstatus.isconnected.md) |  | boolean |  |
-|  [isConnecting](./foundation-comms.serializedsocketstatus.isconnecting.md) |  | boolean |  |
-|  [isDisconnected](./foundation-comms.serializedsocketstatus.isdisconnected.md) |  | boolean |  |
-|  [isDisconnectedByServer](./foundation-comms.serializedsocketstatus.isdisconnectedbyserver.md) |  | boolean |  |
-|  [isReconnecting](./foundation-comms.serializedsocketstatus.isreconnecting.md) |  | boolean |  |
-|  [reconnectionLimitReached](./foundation-comms.serializedsocketstatus.reconnectionlimitreached.md) |  | boolean |  |
-

package/docs/api/foundation-comms.serializedsocketstatus.reconnectionlimitreached.md

@@ -1,11 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md) &gt; [reconnectionLimitReached](./foundation-comms.serializedsocketstatus.reconnectionlimitreached.md)
-
-## SerializedSocketStatus.reconnectionLimitReached property
-
-**Signature:**
-
-```typescript
-reconnectionLimitReached: boolean;
-```

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

@@ -1,28 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SocketStatus](./foundation-comms.socketstatus.md)
-
-## SocketStatus interface
-
-`SocketStatus` provides the state of the web socket.
-
-**Signature:**
-
-```typescript
-export interface SocketStatus extends SerializedSocketStatus 
-```
-**Extends:** [SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md)
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [isConnectedSubject](./foundation-comms.socketstatus.isconnectedsubject.md) |  | BehaviorSubject&lt;boolean&gt; |  |
-
-## Methods
-
-|  Method | Description |
-|  --- | --- |
-|  [onClose(closeEvent)](./foundation-comms.socketstatus.onclose.md) |  |
-|  [serialize()](./foundation-comms.socketstatus.serialize.md) |  |
-

package/docs/api/foundation-comms.socketstatus.onclose.md

@@ -1,22 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SocketStatus](./foundation-comms.socketstatus.md) &gt; [onClose](./foundation-comms.socketstatus.onclose.md)
-
-## SocketStatus.onClose() method
-
-**Signature:**
-
-```typescript
-onClose(closeEvent: CloseEvent): void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  closeEvent | CloseEvent |  |
-
-**Returns:**
-
-void
-

package/docs/api/foundation-comms.socketstatus.serialize.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SocketStatus](./foundation-comms.socketstatus.md) &gt; [serialize](./foundation-comms.socketstatus.serialize.md)
-
-## SocketStatus.serialize() method
-
-**Signature:**
-
-```typescript
-serialize(): SerializedSocketStatus;
-```
-**Returns:**
-
-[SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md)
-

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

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [StreamCompleteEvent](./foundation-comms.streamcompleteevent.md)
-
-## StreamCompleteEvent type
-
-
-**Signature:**
-
-```typescript
-export type StreamCompleteEvent = CustomEvent<SocketObservable<any>>;
-```
-**References:** [SocketObservable](./foundation-comms.socketobservable.md)
-

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

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [StreamCompleteEventType](./foundation-comms.streamcompleteeventtype.md)
-
-## StreamCompleteEventType variable
-
-
-**Signature:**
-
-```typescript
-StreamCompleteEventType = "connect-stream-complete-event"
-```

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

@@ -1,14 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [StreamEvent](./foundation-comms.streamevent.md)
-
-## StreamEvent type
-
-
-**Signature:**
-
-```typescript
-export type StreamEvent = CustomEvent<StreamEventDetail>;
-```
-**References:** [StreamEventDetail](./foundation-comms.streameventdetail.md)
-

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

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [StreamEventDetail](./foundation-comms.streameventdetail.md)
-
-## StreamEventDetail type
-
-
-**Signature:**
-
-```typescript
-export type StreamEventDetail = {
-    functions: StreamEventFunctions;
-    message: Message<MessageDetails.DataserverRequest>;
-    resourceName: string;
-    stream: SocketObservable<any>;
-};
-```
-**References:** [StreamEventFunctions](./foundation-comms.streameventfunctions.md)<!-- -->, [Message](./foundation-comms.message.md)<!-- -->, [MessageDetails.DataserverRequest](./foundation-comms.messagedetails.dataserverrequest.md)<!-- -->, [SocketObservable](./foundation-comms.socketobservable.md)
-

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

@@ -1,19 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [StreamEventFunctions](./foundation-comms.streameventfunctions.md)
-
-## StreamEventFunctions type
-
-
-**Signature:**
-
-```typescript
-export type StreamEventFunctions = {
-    onMessage?: Function;
-    onError?: Function;
-    resourceChecks?: MonitoredResourceChecks;
-    resourceDataLogon?: MonitoredResourceDataLogon;
-};
-```
-**References:** [MonitoredResourceChecks](./foundation-comms.monitoredresourcechecks.md)<!-- -->, [MonitoredResourceDataLogon](./foundation-comms.monitoredresourcedatalogon.md)
-

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

@@ -1,12 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [StreamEventType](./foundation-comms.streameventtype.md)
-
-## StreamEventType variable
-
-
-**Signature:**
-
-```typescript
-StreamEventType = "connect-stream-event"
-```

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

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [SystemHealthChanged](./foundation-comms.systemhealthchanged.md)
-
-## SystemHealthChanged variable
-
-SystemHealthChanged.
-
-**Signature:**
-
-```typescript
-SystemHealthChanged = "system-health-changed"
-```