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

package/docs/api/foundation-comms.defaultmessagebuilder.createmetarequestmessage.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; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createMetaRequestMessage](./foundation-comms.defaultmessagebuilder.createmetarequestmessage.md)
-
-## DefaultMessageBuilder.createMetaRequestMessage() method
-
-**Signature:**
-
-```typescript
-createMetaRequestMessage(resourceName: string, messageType?: EventMessageType): Message<MessageDetails.MetaRequest>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  resourceName | string |  |
-|  messageType | [EventMessageType](./foundation-comms.eventmessagetype.md) | _(Optional)_ |
-
-**Returns:**
-
-[Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.MetaRequest](./foundation-comms.messagedetails.metarequest.md)<!-- -->&gt;
-

package/docs/api/foundation-comms.defaultmessagebuilder.createmorecolumnsmessage.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; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createMoreColumnsMessage](./foundation-comms.defaultmessagebuilder.createmorecolumnsmessage.md)
-
-## DefaultMessageBuilder.createMoreColumnsMessage() method
-
-**Signature:**
-
-```typescript
-createMoreColumnsMessage(sourceRef: string): Message;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  sourceRef | string |  |
-
-**Returns:**
-
-[Message](./foundation-comms.message.md)
-

package/docs/api/foundation-comms.defaultmessagebuilder.createmorerowsmessage.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; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createMoreRowsMessage](./foundation-comms.defaultmessagebuilder.createmorerowsmessage.md)
-
-## DefaultMessageBuilder.createMoreRowsMessage() method
-
-**Signature:**
-
-```typescript
-createMoreRowsMessage(sourceRef: string): Message;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  sourceRef | string |  |
-
-**Returns:**
-
-[Message](./foundation-comms.message.md)
-

package/docs/api/foundation-comms.defaultmessagebuilder.createrefreshtokenmessage.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; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createRefreshTokenMessage](./foundation-comms.defaultmessagebuilder.createrefreshtokenmessage.md)
-
-## DefaultMessageBuilder.createRefreshTokenMessage() method
-
-**Signature:**
-
-```typescript
-createRefreshTokenMessage(): Message<MessageDetails.RefreshToken>;
-```
-**Returns:**
-
-[Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.RefreshToken](./foundation-comms.messagedetails.refreshtoken.md)<!-- -->&gt;
-

package/docs/api/foundation-comms.defaultmessagebuilder.createrequestmessage.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; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createRequestMessage](./foundation-comms.defaultmessagebuilder.createrequestmessage.md)
-
-## DefaultMessageBuilder.createRequestMessage() method
-
-**Signature:**
-
-```typescript
-createRequestMessage<T = any>(resourceName: string, params?: RequestParams): Message<T>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  resourceName | string |  |
-|  params | [RequestParams](./foundation-comms.requestparams.md) | _(Optional)_ |
-
-**Returns:**
-
-[Message](./foundation-comms.message.md)<!-- -->&lt;T&gt;
-

package/docs/api/foundation-comms.defaultmessagebuilder.createresourcesmessage.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; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createResourcesMessage](./foundation-comms.defaultmessagebuilder.createresourcesmessage.md)
-
-## DefaultMessageBuilder.createResourcesMessage() method
-
-**Signature:**
-
-```typescript
-createResourcesMessage<T = any>(params?: RequestParams): Message<T>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  params | [RequestParams](./foundation-comms.requestparams.md) | _(Optional)_ |
-
-**Returns:**
-
-[Message](./foundation-comms.message.md)<!-- -->&lt;T&gt;
-

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

@@ -1,41 +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; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md)
-
-## DefaultMessageBuilder class
-
-Default MessageBuilder implementation.
-
-**Signature:**
-
-```typescript
-export declare class DefaultMessageBuilder implements MessageBuilder 
-```
-**Implements:** [MessageBuilder](./foundation-comms.messagebuilder.md)
-
-## Constructors
-
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(session, uuid)](./foundation-comms.defaultmessagebuilder._constructor_.md) |  | UUID will be created in the DI with the App specific requirements. Keeping it encapsulated means messages will always conform. |
-
-## Methods
-
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [createChangePasswordMessage(username, oldPassword, newPassword)](./foundation-comms.defaultmessagebuilder.createchangepasswordmessage.md) |  |  |
-|  [createCommitMessage(eventName, params)](./foundation-comms.defaultmessagebuilder.createcommitmessage.md) |  |  |
-|  [createDataLogoffMessage(sourceRef)](./foundation-comms.defaultmessagebuilder.createdatalogoffmessage.md) |  |  |
-|  [createDataLogonMessage(resourceName, params)](./foundation-comms.defaultmessagebuilder.createdatalogonmessage.md) |  |  |
-|  [createForgotPasswordMessage(username, returnUrl, requester)](./foundation-comms.defaultmessagebuilder.createforgotpasswordmessage.md) |  |  |
-|  [createForgotPasswordTokenMessage(username, resetToken, newPassword, requester)](./foundation-comms.defaultmessagebuilder.createforgotpasswordtokenmessage.md) |  |  |
-|  [createHTTPHeadersFromMessage(message, contentType)](./foundation-comms.defaultmessagebuilder.createhttpheadersfrommessage.md) |  |  |
-|  [createLoginMessage(credentials)](./foundation-comms.defaultmessagebuilder.createloginmessage.md) |  |  |
-|  [createLogoutMessage(loginResult)](./foundation-comms.defaultmessagebuilder.createlogoutmessage.md) |  |  |
-|  [createMetaRequestMessage(resourceName, messageType)](./foundation-comms.defaultmessagebuilder.createmetarequestmessage.md) |  |  |
-|  [createMoreColumnsMessage(sourceRef)](./foundation-comms.defaultmessagebuilder.createmorecolumnsmessage.md) |  |  |
-|  [createMoreRowsMessage(sourceRef)](./foundation-comms.defaultmessagebuilder.createmorerowsmessage.md) |  |  |
-|  [createRefreshTokenMessage()](./foundation-comms.defaultmessagebuilder.createrefreshtokenmessage.md) |  |  |
-|  [createRequestMessage(resourceName, params)](./foundation-comms.defaultmessagebuilder.createrequestmessage.md) |  |  |
-|  [createResourcesMessage(params)](./foundation-comms.defaultmessagebuilder.createresourcesmessage.md) |  |  |
-

package/docs/api/foundation-comms.defaultnetworkmonitor.addresource.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; [DefaultNetworkMonitor](./foundation-comms.defaultnetworkmonitor.md) &gt; [addResource](./foundation-comms.defaultnetworkmonitor.addresource.md)
-
-## DefaultNetworkMonitor.addResource() method
-
-**Signature:**
-
-```typescript
-addResource(resource: MonitoredResource, metadata: MonitoredResourceMetadata): void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  resource | [MonitoredResource](./foundation-comms.monitoredresource.md) | The resource reference. |
-|  metadata | [MonitoredResourceMetadata](./foundation-comms.monitoredresourcemetadata.md) | The resource metadata. |
-
-**Returns:**
-
-void
-

package/docs/api/foundation-comms.defaultnetworkmonitor.create.md

@@ -1,16 +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; [DefaultNetworkMonitor](./foundation-comms.defaultnetworkmonitor.md) &gt; [create](./foundation-comms.defaultnetworkmonitor.create.md)
-
-## DefaultNetworkMonitor.create() method
-
-
-**Signature:**
-
-```typescript
-create(): void;
-```
-**Returns:**
-
-void
-

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

@@ -1,16 +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; [DefaultNetworkMonitor](./foundation-comms.defaultnetworkmonitor.md) &gt; [destroy](./foundation-comms.defaultnetworkmonitor.destroy.md)
-
-## DefaultNetworkMonitor.destroy() method
-
-
-**Signature:**
-
-```typescript
-destroy(): void;
-```
-**Returns:**
-
-void
-

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

@@ -1,31 +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; [DefaultNetworkMonitor](./foundation-comms.defaultnetworkmonitor.md)
-
-## DefaultNetworkMonitor class
-
-Default NetworkMonitor implementation.
-
-**Signature:**
-
-```typescript
-export declare class DefaultNetworkMonitor implements NetworkMonitor 
-```
-**Implements:** [NetworkMonitor](./foundation-comms.networkmonitor.md)
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [runAllChecks](./foundation-comms.defaultnetworkmonitor.runallchecks.md) |  | (source?: unknown, force?: boolean) =&gt; Promise&lt;void&gt; |  |
-|  [status](./foundation-comms.defaultnetworkmonitor.status.md) |  | [SystemHealthStatus](./foundation-comms.systemhealthstatus.md) |  |
-
-## Methods
-
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [addResource(resource, metadata)](./foundation-comms.defaultnetworkmonitor.addresource.md) |  |  |
-|  [create()](./foundation-comms.defaultnetworkmonitor.create.md) |  |  |
-|  [destroy()](./foundation-comms.defaultnetworkmonitor.destroy.md) |  |  |
-|  [removeResource(resource)](./foundation-comms.defaultnetworkmonitor.removeresource.md) |  |  |
-

package/docs/api/foundation-comms.defaultnetworkmonitor.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; [DefaultNetworkMonitor](./foundation-comms.defaultnetworkmonitor.md) &gt; [removeResource](./foundation-comms.defaultnetworkmonitor.removeresource.md)
-
-## DefaultNetworkMonitor.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.defaultnetworkmonitor.runallchecks.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; [DefaultNetworkMonitor](./foundation-comms.defaultnetworkmonitor.md) &gt; [runAllChecks](./foundation-comms.defaultnetworkmonitor.runallchecks.md)
-
-## DefaultNetworkMonitor.runAllChecks property
-
-**Signature:**
-
-```typescript
-runAllChecks: (source?: unknown, force?: boolean) => Promise<void>;
-```

package/docs/api/foundation-comms.defaultnetworkmonitor.status.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; [DefaultNetworkMonitor](./foundation-comms.defaultnetworkmonitor.md) &gt; [status](./foundation-comms.defaultnetworkmonitor.status.md)
-
-## DefaultNetworkMonitor.status property
-
-
-**Signature:**
-
-```typescript
-status: SystemHealthStatus;
-```

package/docs/api/foundation-comms.defaultnetworkmonitorconfig.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; [defaultNetworkMonitorConfig](./foundation-comms.defaultnetworkmonitorconfig.md)
-
-## defaultNetworkMonitorConfig variable
-
-Default NetworkMonitorConfig DI implementation.
-
-**Signature:**
-
-```typescript
-defaultNetworkMonitorConfig: NetworkMonitorConfig
-```

package/docs/api/foundation-comms.defaultsocket._constructor_.md

@@ -1,24 +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; [DefaultSocket](./foundation-comms.defaultsocket.md) &gt; [(constructor)](./foundation-comms.defaultsocket._constructor_.md)
-
-## DefaultSocket.(constructor)
-
-Constructs a new instance of the `DefaultSocket` class
-
-**Signature:**
-
-```typescript
-constructor(messageBuilder: MessageBuilder, session: Session, serializer: JSONSerializer, uuid: UUID, status: SocketStatus);
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  messageBuilder | [MessageBuilder](./foundation-comms.messagebuilder.md) |  |
-|  session | [Session](./foundation-comms.session.md) |  |
-|  serializer | JSONSerializer |  |
-|  uuid | UUID |  |
-|  status | [SocketStatus](./foundation-comms.socketstatus.md) |  |
-

package/docs/api/foundation-comms.defaultsocket.connect.md

@@ -1,24 +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; [DefaultSocket](./foundation-comms.defaultsocket.md) &gt; [connect](./foundation-comms.defaultsocket.connect.md)
-
-## DefaultSocket.connect() method
-
-**Signature:**
-
-```typescript
-connect(host: string, connectOptions?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  host | string |  |
-|  connectOptions | [SocketConnectOptions](./foundation-comms.socketconnectoptions.md) | _(Optional)_ |
-|  reconnectOptions | [SocketReconnectOptions](./foundation-comms.socketreconnectoptions.md) | _(Optional)_ |
-
-**Returns:**
-
-Promise&lt;boolean&gt;
-

package/docs/api/foundation-comms.defaultsocket.hasvalidsession.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; [DefaultSocket](./foundation-comms.defaultsocket.md) &gt; [hasValidSession](./foundation-comms.defaultsocket.hasvalidsession.md)
-
-## DefaultSocket.hasValidSession property
-
-**Signature:**
-
-```typescript
-get hasValidSession(): boolean;
-
-set hasValidSession(value: boolean);
-```

package/docs/api/foundation-comms.defaultsocket.isconfigured.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; [DefaultSocket](./foundation-comms.defaultsocket.md) &gt; [isConfigured](./foundation-comms.defaultsocket.isconfigured.md)
-
-## DefaultSocket.isConfigured property
-
-**Signature:**
-
-```typescript
-get isConfigured(): boolean;
-```

package/docs/api/foundation-comms.defaultsocket.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; [DefaultSocket](./foundation-comms.defaultsocket.md) &gt; [isConnected](./foundation-comms.defaultsocket.isconnected.md)
-
-## DefaultSocket.isConnected property
-
-**Signature:**
-
-```typescript
-get isConnected(): boolean;
-```

package/docs/api/foundation-comms.defaultsocket.isconnectedsubject.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; [DefaultSocket](./foundation-comms.defaultsocket.md) &gt; [isConnectedSubject](./foundation-comms.defaultsocket.isconnectedsubject.md)
-
-## DefaultSocket.isConnectedSubject property
-
-**Signature:**
-
-```typescript
-get isConnectedSubject(): import("rxjs").BehaviorSubject<boolean>;
-```

package/docs/api/foundation-comms.defaultsocket.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; [DefaultSocket](./foundation-comms.defaultsocket.md) &gt; [isConnecting](./foundation-comms.defaultsocket.isconnecting.md)
-
-## DefaultSocket.isConnecting property
-
-**Signature:**
-
-```typescript
-get isConnecting(): boolean;
-```

package/docs/api/foundation-comms.defaultsocket.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; [DefaultSocket](./foundation-comms.defaultsocket.md) &gt; [isDisconnected](./foundation-comms.defaultsocket.isdisconnected.md)
-
-## DefaultSocket.isDisconnected property
-
-**Signature:**
-
-```typescript
-get isDisconnected(): boolean;
-```

package/docs/api/foundation-comms.defaultsocket.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; [DefaultSocket](./foundation-comms.defaultsocket.md) &gt; [isDisconnectedByServer](./foundation-comms.defaultsocket.isdisconnectedbyserver.md)
-
-## DefaultSocket.isDisconnectedByServer property
-
-**Signature:**
-
-```typescript
-get isDisconnectedByServer(): boolean;
-```

package/docs/api/foundation-comms.defaultsocket.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; [DefaultSocket](./foundation-comms.defaultsocket.md) &gt; [isReconnecting](./foundation-comms.defaultsocket.isreconnecting.md)
-
-## DefaultSocket.isReconnecting property
-
-**Signature:**
-
-```typescript
-get isReconnecting(): boolean;
-```

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

@@ -1,44 +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; [DefaultSocket](./foundation-comms.defaultsocket.md)
-
-## DefaultSocket class
-
-Default Socket implementation.
-
-**Signature:**
-
-```typescript
-export declare class DefaultSocket implements Socket 
-```
-**Implements:** [Socket](./foundation-comms.socket.md)
-
-## Constructors
-
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(messageBuilder, session, serializer, uuid, status)](./foundation-comms.defaultsocket._constructor_.md) |  | Constructs a new instance of the <code>DefaultSocket</code> class |
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [hasValidSession](./foundation-comms.defaultsocket.hasvalidsession.md) |  | boolean |  |
-|  [isConfigured](./foundation-comms.defaultsocket.isconfigured.md) | <code>readonly</code> | boolean |  |
-|  [isConnected](./foundation-comms.defaultsocket.isconnected.md) | <code>readonly</code> | boolean |  |
-|  [isConnectedSubject](./foundation-comms.defaultsocket.isconnectedsubject.md) | <code>readonly</code> | import("rxjs").BehaviorSubject&lt;boolean&gt; |  |
-|  [isConnecting](./foundation-comms.defaultsocket.isconnecting.md) | <code>readonly</code> | boolean |  |
-|  [isDisconnected](./foundation-comms.defaultsocket.isdisconnected.md) | <code>readonly</code> | boolean |  |
-|  [isDisconnectedByServer](./foundation-comms.defaultsocket.isdisconnectedbyserver.md) | <code>readonly</code> | boolean |  |
-|  [isReconnecting](./foundation-comms.defaultsocket.isreconnecting.md) | <code>readonly</code> | boolean |  |
-|  [socketMessages](./foundation-comms.defaultsocket.socketmessages.md) |  | () =&gt; [SocketSubject](./foundation-comms.socketsubject.md)<!-- -->&lt;[Message](./foundation-comms.message.md)<!-- -->&gt; |  |
-
-## Methods
-
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [connect(host, connectOptions, reconnectOptions)](./foundation-comms.defaultsocket.connect.md) |  |  |
-|  [reset()](./foundation-comms.defaultsocket.reset.md) |  |  |
-|  [send(message, needsHandling)](./foundation-comms.defaultsocket.send.md) |  |  |
-|  [sendForStream(message, onMessage, onError, onComplete)](./foundation-comms.defaultsocket.sendforstream.md) |  |  |
-

package/docs/api/foundation-comms.defaultsocket.reset.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; [DefaultSocket](./foundation-comms.defaultsocket.md) &gt; [reset](./foundation-comms.defaultsocket.reset.md)
-
-## DefaultSocket.reset() method
-
-**Signature:**
-
-```typescript
-reset(): void;
-```
-**Returns:**
-
-void
-

package/docs/api/foundation-comms.defaultsocket.send.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; [DefaultSocket](./foundation-comms.defaultsocket.md) &gt; [send](./foundation-comms.defaultsocket.send.md)
-
-## DefaultSocket.send() method
-
-**Signature:**
-
-```typescript
-send<T>(message: Message<T | any>, needsHandling?: boolean): Promise<Message | any>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  message | [Message](./foundation-comms.message.md)<!-- -->&lt;T \| any&gt; |  |
-|  needsHandling | boolean | _(Optional)_ |
-
-**Returns:**
-
-Promise&lt;[Message](./foundation-comms.message.md) \| any&gt;
-

package/docs/api/foundation-comms.defaultsocket.sendforstream.md

@@ -1,25 +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; [DefaultSocket](./foundation-comms.defaultsocket.md) &gt; [sendForStream](./foundation-comms.defaultsocket.sendforstream.md)
-
-## DefaultSocket.sendForStream() method
-
-**Signature:**
-
-```typescript
-sendForStream<T>(message: Message<T | any>, onMessage: Function, onError: Function, onComplete?: Function): Observable<Message>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  message | [Message](./foundation-comms.message.md)<!-- -->&lt;T \| any&gt; |  |
-|  onMessage | Function |  |
-|  onError | Function |  |
-|  onComplete | Function | _(Optional)_ |
-
-**Returns:**
-
-Observable&lt;[Message](./foundation-comms.message.md)<!-- -->&gt;
-

package/docs/api/foundation-comms.defaultsocket.socketmessages.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; [DefaultSocket](./foundation-comms.defaultsocket.md) &gt; [socketMessages](./foundation-comms.defaultsocket.socketmessages.md)
-
-## DefaultSocket.socketMessages property
-
-**Signature:**
-
-```typescript
-socketMessages: () => SocketSubject<Message>;
-```

package/docs/api/foundation-comms.defaultsocketstatus.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; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) &gt; [closedClean](./foundation-comms.defaultsocketstatus.closedclean.md)
-
-## DefaultSocketStatus.closedClean property
-
-**Signature:**
-
-```typescript
-closedClean: any;
-```

package/docs/api/foundation-comms.defaultsocketstatus.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; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) &gt; [closedCode](./foundation-comms.defaultsocketstatus.closedcode.md)
-
-## DefaultSocketStatus.closedCode property
-
-**Signature:**
-
-```typescript
-closedCode: any;
-```

package/docs/api/foundation-comms.defaultsocketstatus.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; [DefaultSocketStatus](./foundation-comms.defaultsocketstatus.md) &gt; [closedReason](./foundation-comms.defaultsocketstatus.closedreason.md)
-
-## DefaultSocketStatus.closedReason property
-
-**Signature:**
-
-```typescript
-closedReason: any;
-```