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

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

@@ -0,0 +1,13 @@
+<!-- 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

@@ -0,0 +1,24 @@
+<!-- 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

@@ -0,0 +1,24 @@
+<!-- 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

@@ -0,0 +1,13 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,44 @@
+<!-- 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

@@ -0,0 +1,15 @@
+<!-- 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

@@ -0,0 +1,23 @@
+<!-- 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

@@ -0,0 +1,25 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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

@@ -0,0 +1,11 @@
+<!-- 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;
+```

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

@@ -0,0 +1,11 @@
+<!-- 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; [hasValidSession](./foundation-comms.defaultsocketstatus.hasvalidsession.md)
+
+## DefaultSocketStatus.hasValidSession property
+
+**Signature:**
+
+```typescript
+hasValidSession: boolean;
+```

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

@@ -0,0 +1,11 @@
+<!-- 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; [isConfigured](./foundation-comms.defaultsocketstatus.isconfigured.md)
+
+## DefaultSocketStatus.isConfigured property
+
+**Signature:**
+
+```typescript
+isConfigured: boolean;
+```

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

@@ -0,0 +1,11 @@
+<!-- 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; [isConnected](./foundation-comms.defaultsocketstatus.isconnected.md)
+
+## DefaultSocketStatus.isConnected property
+
+**Signature:**
+
+```typescript
+isConnected: boolean;
+```

package/docs/api/foundation-comms.defaultsocketstatus.isconnectedchanged.md

@@ -0,0 +1,15 @@
+<!-- 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; [isConnectedChanged](./foundation-comms.defaultsocketstatus.isconnectedchanged.md)
+
+## DefaultSocketStatus.isConnectedChanged() method
+
+**Signature:**
+
+```typescript
+protected isConnectedChanged(): void;
+```
+**Returns:**
+
+void
+

package/docs/api/foundation-comms.defaultsocketstatus.isconnectedsubject.md

@@ -0,0 +1,11 @@
+<!-- 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; [isConnectedSubject](./foundation-comms.defaultsocketstatus.isconnectedsubject.md)
+
+## DefaultSocketStatus.isConnectedSubject property
+
+**Signature:**
+
+```typescript
+isConnectedSubject: BehaviorSubject<boolean>;
+```

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

@@ -0,0 +1,11 @@
+<!-- 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; [isConnecting](./foundation-comms.defaultsocketstatus.isconnecting.md)
+
+## DefaultSocketStatus.isConnecting property
+
+**Signature:**
+
+```typescript
+isConnecting: boolean;
+```

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

@@ -0,0 +1,11 @@
+<!-- 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; [isDisconnected](./foundation-comms.defaultsocketstatus.isdisconnected.md)
+
+## DefaultSocketStatus.isDisconnected property
+
+**Signature:**
+
+```typescript
+get isDisconnected(): boolean;
+```

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

@@ -0,0 +1,11 @@
+<!-- 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; [isDisconnectedByServer](./foundation-comms.defaultsocketstatus.isdisconnectedbyserver.md)
+
+## DefaultSocketStatus.isDisconnectedByServer property
+
+**Signature:**
+
+```typescript
+get isDisconnectedByServer(): boolean;
+```

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

@@ -0,0 +1,11 @@
+<!-- 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; [isReconnecting](./foundation-comms.defaultsocketstatus.isreconnecting.md)
+
+## DefaultSocketStatus.isReconnecting property
+
+**Signature:**
+
+```typescript
+isReconnecting: boolean;
+```

package/docs/api/foundation-comms.defaultsocketstatus.isreconnectingchanged.md

@@ -0,0 +1,15 @@
+<!-- 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; [isReconnectingChanged](./foundation-comms.defaultsocketstatus.isreconnectingchanged.md)
+
+## DefaultSocketStatus.isReconnectingChanged() method
+
+**Signature:**
+
+```typescript
+protected isReconnectingChanged(): void;
+```
+**Returns:**
+
+void
+

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

@@ -0,0 +1,42 @@
+<!-- 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)
+
+## DefaultSocketStatus class
+
+Default SocketStatus implementation.
+
+**Signature:**
+
+```typescript
+export declare class DefaultSocketStatus implements SocketStatus 
+```
+**Implements:** [SocketStatus](./foundation-comms.socketstatus.md)
+
+## Properties
+
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [closedClean](./foundation-comms.defaultsocketstatus.closedclean.md) |  | any |  |
+|  [closedCode](./foundation-comms.defaultsocketstatus.closedcode.md) |  | any |  |
+|  [closedReason](./foundation-comms.defaultsocketstatus.closedreason.md) |  | any |  |
+|  [hasValidSession](./foundation-comms.defaultsocketstatus.hasvalidsession.md) |  | boolean |  |
+|  [isConfigured](./foundation-comms.defaultsocketstatus.isconfigured.md) |  | boolean |  |
+|  [isConnected](./foundation-comms.defaultsocketstatus.isconnected.md) |  | boolean |  |
+|  [isConnectedSubject](./foundation-comms.defaultsocketstatus.isconnectedsubject.md) |  | BehaviorSubject&lt;boolean&gt; |  |
+|  [isConnecting](./foundation-comms.defaultsocketstatus.isconnecting.md) |  | boolean |  |
+|  [isDisconnected](./foundation-comms.defaultsocketstatus.isdisconnected.md) | <code>readonly</code> | boolean |  |
+|  [isDisconnectedByServer](./foundation-comms.defaultsocketstatus.isdisconnectedbyserver.md) | <code>readonly</code> | boolean |  |
+|  [isReconnecting](./foundation-comms.defaultsocketstatus.isreconnecting.md) |  | boolean |  |
+|  [reconnectionLimitReached](./foundation-comms.defaultsocketstatus.reconnectionlimitreached.md) |  | boolean |  |
+
+## Methods
+
+|  Method | Modifiers | Description |
+|  --- | --- | --- |
+|  [isConnectedChanged()](./foundation-comms.defaultsocketstatus.isconnectedchanged.md) | <code>protected</code> |  |
+|  [isReconnectingChanged()](./foundation-comms.defaultsocketstatus.isreconnectingchanged.md) | <code>protected</code> |  |
+|  [onClose(event)](./foundation-comms.defaultsocketstatus.onclose.md) |  |  |
+|  [resetClosedState()](./foundation-comms.defaultsocketstatus.resetclosedstate.md) | <code>protected</code> |  |
+|  [serialize()](./foundation-comms.defaultsocketstatus.serialize.md) |  |  |
+

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

@@ -0,0 +1,22 @@
+<!-- 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; [onClose](./foundation-comms.defaultsocketstatus.onclose.md)
+
+## DefaultSocketStatus.onClose() method
+
+**Signature:**
+
+```typescript
+onClose(event: CloseEvent): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  event | CloseEvent |  |
+
+**Returns:**
+
+void
+

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

@@ -0,0 +1,11 @@
+<!-- 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; [reconnectionLimitReached](./foundation-comms.defaultsocketstatus.reconnectionlimitreached.md)
+
+## DefaultSocketStatus.reconnectionLimitReached property
+
+**Signature:**
+
+```typescript
+reconnectionLimitReached: boolean;
+```

package/docs/api/foundation-comms.defaultsocketstatus.resetclosedstate.md

@@ -0,0 +1,15 @@
+<!-- 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; [resetClosedState](./foundation-comms.defaultsocketstatus.resetclosedstate.md)
+
+## DefaultSocketStatus.resetClosedState() method
+
+**Signature:**
+
+```typescript
+protected resetClosedState(): void;
+```
+**Returns:**
+
+void
+

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

@@ -0,0 +1,15 @@
+<!-- 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; [serialize](./foundation-comms.defaultsocketstatus.serialize.md)
+
+## DefaultSocketStatus.serialize() method
+
+**Signature:**
+
+```typescript
+serialize(): SerializedSocketStatus;
+```
+**Returns:**
+
+[SerializedSocketStatus](./foundation-comms.serializedsocketstatus.md)
+

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

@@ -0,0 +1,18 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [GenesisConnectEvents](./foundation-comms.genesisconnectevents.md)
+
+## GenesisConnectEvents type
+
+Genesis connect events that can be monitored to invoke resource checking.
+
+**Signature:**
+
+```typescript
+export type GenesisConnectEvents = 'stream' | 'commit';
+```
+
+## Remarks
+
+'steam' and 'commit' are monitored by default and will invoke resource checking. 'metadata' request failures are monitored for the purpose of surfacing such errors to the console only. For now, 'metadata' errors are unrecoverable.
+

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

@@ -0,0 +1,30 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [getNetworkMonitor](./foundation-comms.getnetworkmonitor.md)
+
+## getNetworkMonitor() function
+
+Gets NetworkMonitor from the DI container.
+
+**Signature:**
+
+```typescript
+export declare function getNetworkMonitor(): NetworkMonitor;
+```
+**Returns:**
+
+[NetworkMonitor](./foundation-comms.networkmonitor.md)
+
+## Remarks
+
+A utility method for host applications that are not using decorators or the DI container.
+
+## Example
+
+
+```ts
+import { getNetworkMonitor } from '@genesislcap/foundation-comms';
+...
+private monitor = getNetworkMonitor();
+```
+