@genesislcap/foundation-comms 14.302.1-alpha-475e82d.0 → 14.302.1-alpha-ecc0cfb.0

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

@@ -12,69 +12,11 @@ connect(host: string, options?: SocketConnectOptions, reconnectOptions?: SocketR
 
 ## Parameters
 
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-host
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-options
-
-
-</td><td>
-
-[SocketConnectOptions](./foundation-comms.socketconnectoptions.md)
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-<tr><td>
-
-reconnectOptions
-
-
-</td><td>
-
-[SocketReconnectOptions](./foundation-comms.socketreconnectoptions.md)
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  host | string |  |
+|  options | [SocketConnectOptions](./foundation-comms.socketconnectoptions.md) | _(Optional)_ |
+|  reconnectOptions | [SocketReconnectOptions](./foundation-comms.socketreconnectoptions.md) | _(Optional)_ |
 
 **Returns:**
 

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

@@ -15,116 +15,17 @@ export interface Socket extends Omit<SocketStatus, 'serialize' | 'onClose' | 're
 
 ## Properties
 
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[host](./foundation-comms.socket.host.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [host](./foundation-comms.socket.host.md) |  | string |  |
 
 ## Methods
 
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[connect(host, options, reconnectOptions)](./foundation-comms.socket.connect.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[reset()](./foundation-comms.socket.reset.md)
-
-
-</td><td>
-
-Disconnects the socket and clears all subscriptions
-
-
-</td></tr>
-<tr><td>
-
-[send(message, needsHandling)](./foundation-comms.socket.send.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[sendForStream(message, onMessage, onError, onComplete)](./foundation-comms.socket.sendforstream.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[sendForStreamWithoutTeardown(message, onMessage, onError)](./foundation-comms.socket.sendforstreamwithoutteardown.md)
-
-
-</td><td>
-
-**_(ALPHA)_** Sends a message and returns an observable that emits messages received from the server.
-
-
-</td></tr>
-<tr><td>
-
-[socketMessages()](./foundation-comms.socket.socketmessages.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
+|  Method | Description |
+|  --- | --- |
+|  [connect(host, options, reconnectOptions)](./foundation-comms.socket.connect.md) |  |
+|  [reset()](./foundation-comms.socket.reset.md) | Disconnects the socket and clears all subscriptions |
+|  [send(message, needsHandling)](./foundation-comms.socket.send.md) |  |
+|  [sendForStream(message, onMessage, onError, onComplete)](./foundation-comms.socket.sendforstream.md) |  |
+|  [socketMessages()](./foundation-comms.socket.socketmessages.md) |  |
 

package/docs/api/foundation-comms.socket.send.md

@@ -12,53 +12,10 @@ send<T>(message: Message<T | any>, needsHandling?: boolean): Promise<Message | a
 
 ## Parameters
 
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-message
-
-
-</td><td>
-
-[Message](./foundation-comms.message.md)<!-- -->&lt;T \| any&gt;
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-needsHandling
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  message | [Message](./foundation-comms.message.md)<!-- -->&lt;T \| any&gt; |  |
+|  needsHandling | boolean | _(Optional)_ |
 
 **Returns:**
 

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

@@ -12,81 +12,12 @@ sendForStream<T>(message: Message<T | any>, onMessage: Function, onError: Functi
 
 ## Parameters
 
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-message
-
-
-</td><td>
-
-[Message](./foundation-comms.message.md)<!-- -->&lt;T \| any&gt;
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-onMessage
-
-
-</td><td>
-
-Function
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-onError
-
-
-</td><td>
-
-Function
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-onComplete
-
-
-</td><td>
-
-Function
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  message | [Message](./foundation-comms.message.md)<!-- -->&lt;T \| any&gt; |  |
+|  onMessage | Function |  |
+|  onError | Function |  |
+|  onComplete | Function | _(Optional)_ |
 
 **Returns:**
 

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

@@ -14,77 +14,10 @@ constructor(message: Message, onMessage: Function, onError: Function, isSubscrip
 
 ## Parameters
 
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-message
-
-
-</td><td>
-
-[Message](./foundation-comms.message.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-onMessage
-
-
-</td><td>
-
-Function
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-onError
-
-
-</td><td>
-
-Function
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-isSubscription
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  message | [Message](./foundation-comms.message.md) |  |
+|  onMessage | Function |  |
+|  onError | Function |  |
+|  isSubscription | boolean |  |
 

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

@@ -14,144 +14,16 @@ export declare class SocketMessageHandler
 
 ## Constructors
 
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(message, onMessage, onError, isSubscription)](./foundation-comms.socketmessagehandler._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Constructs a new instance of the `SocketMessageHandler` class
-
-
-</td></tr>
-</tbody></table>
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(message, onMessage, onError, isSubscription)](./foundation-comms.socketmessagehandler._constructor_.md) |  | Constructs a new instance of the <code>SocketMessageHandler</code> class |
 
 ## Properties
 
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[isSubscription](./foundation-comms.socketmessagehandler.issubscription.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Whether the message handler is a subscription.
-
-
-</td></tr>
-<tr><td>
-
-[onReceivedError](./foundation-comms.socketmessagehandler.onreceivederror.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-Function
-
-
-</td><td>
-
-The handler function for errors.
-
-
-</td></tr>
-<tr><td>
-
-[onReceivedMessage](./foundation-comms.socketmessagehandler.onreceivedmessage.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-Function
-
-
-</td><td>
-
-The handler function for incoming messages.
-
-
-</td></tr>
-<tr><td>
-
-[sentMessage](./foundation-comms.socketmessagehandler.sentmessage.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-[Message](./foundation-comms.message.md)
-
-
-</td><td>
-
-The message that was sent.
-
-
-</td></tr>
-</tbody></table>
+|  Property | Modifiers | Type | Description |
+|  --- | --- | --- | --- |
+|  [isSubscription](./foundation-comms.socketmessagehandler.issubscription.md) | <code>readonly</code> | boolean | Whether the message handler is a subscription. |
+|  [onReceivedError](./foundation-comms.socketmessagehandler.onreceivederror.md) | <code>readonly</code> | Function | The handler function for errors. |
+|  [onReceivedMessage](./foundation-comms.socketmessagehandler.onreceivedmessage.md) | <code>readonly</code> | Function | The handler function for incoming messages. |
+|  [sentMessage](./foundation-comms.socketmessagehandler.sentmessage.md) | <code>readonly</code> | [Message](./foundation-comms.message.md) | The message that was sent. |
 

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

@@ -14,35 +14,7 @@ constructor(...args: any[]);
 
 ## Parameters
 
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-args
-
-
-</td><td>
-
-any\[\]
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  args | any\[\] |  |
 

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

@@ -19,35 +19,7 @@ An alias to RxJS Observable.
 
 ## Constructors
 
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(args)](./foundation-comms.socketobservable._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-Constructs a new instance of the `SocketObservable` class
-
-
-</td></tr>
-</tbody></table>
+|  Constructor | Modifiers | Description |
+|  --- | --- | --- |
+|  [(constructor)(args)](./foundation-comms.socketobservable._constructor_.md) |  | Constructs a new instance of the <code>SocketObservable</code> class |
 

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

@@ -14,49 +14,8 @@ export declare enum SocketReconnectStrategy
 
 ## Enumeration Members
 
-<table><thead><tr><th>
-
-Member
-
-
-</th><th>
-
-Value
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-Exponential
-
-
-</td><td>
-
-`"exponential"`
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-Linear
-
-
-</td><td>
-
-`"linear"`
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
+|  Member | Value | Description |
+|  --- | --- | --- |
+|  Exponential | <code>&quot;exponential&quot;</code> |  |
+|  Linear | <code>&quot;linear&quot;</code> |  |