@genesislcap/foundation-comms 14.301.0 → 14.302.1-alpha-d11831b.0

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

@@ -2,7 +2,7 @@
 
 [Home](./index.md) > [@genesislcap/foundation-comms](./foundation-comms.md) > [messageOrThrow](./foundation-comms.messageorthrow.md)
 
-## messageOrThrow variable
+## messageOrThrow() function
 
 Check if the provided message contains an error and throw an Error if it does
 
@@ -11,3 +11,46 @@ Check if the provided message contains an error and throw an Error if it does
 ```typescript
 messageOrThrow: (message: Message) => Message<any>
 ```
+
+## 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>
+
+Message to check for errors
+
+
+</td></tr>
+</tbody></table>
+
+**Returns:**
+
+[Message](./foundation-comms.message.md)<!-- -->&lt;any&gt;
+
+The message if no errors are present, otherwise throws an Error
+

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

@@ -14,20 +14,217 @@ export declare enum MessageType
 
 ## Enumeration Members
 
-|  Member | Value | Description |
-|  --- | --- | --- |
-|  HEARTBEAT\_PING | <code>&quot;HEARTBEAT_PING&quot;</code> |  |
-|  HEARTBEAT\_PONG | <code>&quot;HEARTBEAT_PONG&quot;</code> |  |
-|  LOGOFF\_ACK | <code>&quot;LOGOFF_ACK&quot;</code> |  |
-|  LOGOFF\_NACK | <code>&quot;LOGOFF_NACK&quot;</code> |  |
-|  LOGON\_ACK | <code>&quot;LOGON_ACK&quot;</code> |  |
-|  LOGON\_NACK | <code>&quot;LOGON_NACK&quot;</code> |  |
-|  LOGOUT\_ACK | <code>&quot;LOGOUT_ACK&quot;</code> |  |
-|  LOGOUT\_NACK | <code>&quot;LOGOUT_NACK&quot;</code> |  |
-|  MORE\_COLUMNS | <code>&quot;MORE_COLUMNS&quot;</code> |  |
-|  MORE\_COLUMNS\_ACK | <code>&quot;MORE_COLUMNS_ACK&quot;</code> |  |
-|  MORE\_ROWS | <code>&quot;MORE_ROWS&quot;</code> |  |
-|  MSG\_ACK | <code>&quot;MSG_ACK&quot;</code> |  |
-|  MSG\_NACK | <code>&quot;MSG_NACK&quot;</code> |  |
-|  QUERY\_UPDATE | <code>&quot;QUERY_UPDATE&quot;</code> |  |
+<table><thead><tr><th>
+
+Member
+
+
+</th><th>
+
+Value
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+HEARTBEAT\_PING
+
+
+</td><td>
+
+`"HEARTBEAT_PING"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+HEARTBEAT\_PONG
+
+
+</td><td>
+
+`"HEARTBEAT_PONG"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+LOGOFF\_ACK
+
+
+</td><td>
+
+`"LOGOFF_ACK"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+LOGOFF\_NACK
+
+
+</td><td>
+
+`"LOGOFF_NACK"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+LOGON\_ACK
+
+
+</td><td>
+
+`"LOGON_ACK"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+LOGON\_NACK
+
+
+</td><td>
+
+`"LOGON_NACK"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+LOGOUT\_ACK
+
+
+</td><td>
+
+`"LOGOUT_ACK"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+LOGOUT\_NACK
+
+
+</td><td>
+
+`"LOGOUT_NACK"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+MORE\_COLUMNS
+
+
+</td><td>
+
+`"MORE_COLUMNS"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+MORE\_COLUMNS\_ACK
+
+
+</td><td>
+
+`"MORE_COLUMNS_ACK"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+MORE\_ROWS
+
+
+</td><td>
+
+`"MORE_ROWS"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+MSG\_ACK
+
+
+</td><td>
+
+`"MSG_ACK"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+MSG\_NACK
+
+
+</td><td>
+
+`"MSG_NACK"`
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+QUERY\_UPDATE
+
+
+</td><td>
+
+`"QUERY_UPDATE"`
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-comms.metadatacache.getmetadatafor.md

@@ -14,9 +14,39 @@ getMetadataFor(resourceName: string): Metadata;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  resourceName | string | The name of the resource. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+resourceName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The name of the resource.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-comms.metadatacache.hasmetadatafor.md

@@ -14,9 +14,39 @@ hasMetadataFor(resourceName: string): boolean;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  resourceName | string | The name of the resource. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+resourceName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The name of the resource.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

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

@@ -14,15 +14,93 @@ export interface MetadataCache
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [cachedMetadata](./foundation-comms.metadatacache.cachedmetadata.md) |  | Map&lt;string, [Metadata](./foundation-comms.metadata.md)<!-- -->&gt; | A map of cached metadata, with resource names as keys and metadata as values. |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[cachedMetadata](./foundation-comms.metadatacache.cachedmetadata.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Map&lt;string, [Metadata](./foundation-comms.metadata.md)<!-- -->&gt;
+
+
+</td><td>
+
+A map of cached metadata, with resource names as keys and metadata as values.
+
+
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-|  Method | Description |
-|  --- | --- |
-|  [getMetadataFor(resourceName)](./foundation-comms.metadatacache.getmetadatafor.md) | Returns the metadata for the specified resource name. |
-|  [hasMetadataFor(resourceName)](./foundation-comms.metadatacache.hasmetadatafor.md) | Returns true if metadata exists for the specified resource name, otherwise false. |
-|  [setMetadataFor(resourceName, metadata)](./foundation-comms.metadatacache.setmetadatafor.md) | Sets the metadata for the specified resource name. |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getMetadataFor(resourceName)](./foundation-comms.metadatacache.getmetadatafor.md)
+
+
+</td><td>
+
+Returns the metadata for the specified resource name.
+
+
+</td></tr>
+<tr><td>
+
+[hasMetadataFor(resourceName)](./foundation-comms.metadatacache.hasmetadatafor.md)
+
+
+</td><td>
+
+Returns true if metadata exists for the specified resource name, otherwise false.
+
+
+</td></tr>
+<tr><td>
+
+[setMetadataFor(resourceName, metadata)](./foundation-comms.metadatacache.setmetadatafor.md)
+
+
+</td><td>
+
+Sets the metadata for the specified resource name.
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-comms.metadatacache.setmetadatafor.md

@@ -14,10 +14,55 @@ setMetadataFor(resourceName: string, metadata: Metadata): void;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  resourceName | string | The name of the resource. |
-|  metadata | [Metadata](./foundation-comms.metadata.md) | The metadata to set. |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+resourceName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+The name of the resource.
+
+
+</td></tr>
+<tr><td>
+
+metadata
+
+
+</td><td>
+
+[Metadata](./foundation-comms.metadata.md)
+
+
+</td><td>
+
+The metadata to set.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

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

@@ -14,10 +14,98 @@ export interface MonitoredResourceChecksResult
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [isConnected](./foundation-comms.monitoredresourcechecksresult.isconnected.md) |  | boolean |  |
-|  [lastMessage?](./foundation-comms.monitoredresourcechecksresult.lastmessage.md) |  | [Message](./foundation-comms.message.md) | _(Optional)_ |
-|  [lastUpdated](./foundation-comms.monitoredresourcechecksresult.lastupdated.md) |  | number |  |
-|  [timeout?](./foundation-comms.monitoredresourcechecksresult.timeout.md) |  | boolean | _(Optional)_ |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[isConnected](./foundation-comms.monitoredresourcechecksresult.isconnected.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[lastMessage?](./foundation-comms.monitoredresourcechecksresult.lastmessage.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[Message](./foundation-comms.message.md)
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[lastUpdated](./foundation-comms.monitoredresourcechecksresult.lastupdated.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[timeout?](./foundation-comms.monitoredresourcechecksresult.timeout.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+_(Optional)_
+
+
+</td></tr>
+</tbody></table>
 

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

@@ -12,10 +12,55 @@ addResource(resource: MonitoredResource, metadata: MonitoredResourceMetadata): v
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  resource | [MonitoredResource](./foundation-comms.monitoredresource.md) | The resource reference. |
-|  metadata | [MonitoredResourceMetadata](./foundation-comms.monitoredresourcemetadata.md) | The resource metadata. |
+<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>
+<tr><td>
+
+metadata
+
+
+</td><td>
+
+[MonitoredResourceMetadata](./foundation-comms.monitoredresourcemetadata.md)
+
+
+</td><td>
+
+The resource metadata.
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**