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

package/docs/api/foundation-comms.defaultconnectevents.onstreamevent.md

@@ -0,0 +1,27 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) &gt; [onStreamEvent](./foundation-comms.defaultconnectevents.onstreamevent.md)
+
+## DefaultConnectEvents.onStreamEvent() method
+
+Called by Connect.
+
+**Signature:**
+
+```typescript
+onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  resourceName | string | The name of the resource. |
+|  message | [Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.DataserverRequest](./foundation-comms.messagedetails.dataserverrequest.md)<!-- -->&gt; | The message. |
+|  stream | [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;any&gt; | The actual stream itself. |
+|  functions | [StreamEventFunctions](./foundation-comms.streameventfunctions.md) | Any functions provided. |
+
+**Returns:**
+
+void
+

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

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

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

@@ -43,6 +43,7 @@ export declare class DefaultDatasource implements Datasource
 |  Method | Modifiers | Description |
 |  --- | --- | --- |
 |  [deinit()](./foundation-comms.defaultdatasource.deinit.md) |  |  |
+|  [destroy()](./foundation-comms.defaultdatasource.destroy.md) |  | Destroy the datasource. |
 |  [init(options, fetchMeta)](./foundation-comms.defaultdatasource.init.md) |  |  |
 |  [snapshot()](./foundation-comms.defaultdatasource.snapshot.md) |  |  |
 |  [snapshotFiltered(rowId)](./foundation-comms.defaultdatasource.snapshotfiltered.md) |  |  |

package/docs/api/foundation-comms.defaulthttpconnect.getmorecolumns.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; [DefaultHttpConnect](./foundation-comms.defaulthttpconnect.md) &gt; [getMoreColumns](./foundation-comms.defaulthttpconnect.getmorecolumns.md)
+
+## DefaultHttpConnect.getMoreColumns() method
+
+**Signature:**
+
+```typescript
+getMoreColumns(sourceRef: string): Promise<Message>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  sourceRef | string |  |
+
+**Returns:**
+
+Promise&lt;[Message](./foundation-comms.message.md)<!-- -->&gt;
+

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

@@ -41,6 +41,7 @@ export declare class DefaultHttpConnect implements Connect
 |  [getAvailableResources(params)](./foundation-comms.defaulthttpconnect.getavailableresources.md) |  |  |
 |  [getJSONSchema(resourceName)](./foundation-comms.defaulthttpconnect.getjsonschema.md) |  |  |
 |  [getMetadata(resourceName, useCache)](./foundation-comms.defaulthttpconnect.getmetadata.md) |  |  |
+|  [getMoreColumns(sourceRef)](./foundation-comms.defaulthttpconnect.getmorecolumns.md) |  |  |
 |  [getMoreRows(sourceRef)](./foundation-comms.defaulthttpconnect.getmorerows.md) |  |  |
 |  [httpMode()](./foundation-comms.defaulthttpconnect.httpmode.md) |  |  |
 |  [request(resourceName, params)](./foundation-comms.defaulthttpconnect.request.md) |  |  |

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

@@ -0,0 +1,21 @@
+<!-- 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; [(constructor)](./foundation-comms.defaultmessagebuilder._constructor_.md)
+
+## DefaultMessageBuilder.(constructor)
+
+UUID will be created in the DI with the App specific requirements. Keeping it encapsulated means messages will always conform.
+
+**Signature:**
+
+```typescript
+constructor(session: Session, uuid: UUID);
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  session | [Session](./foundation-comms.session.md) |  |
+|  uuid | UUID |  |
+

package/docs/api/foundation-comms.defaultmessagebuilder.createchangepasswordmessage.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; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createChangePasswordMessage](./foundation-comms.defaultmessagebuilder.createchangepasswordmessage.md)
+
+## DefaultMessageBuilder.createChangePasswordMessage() method
+
+**Signature:**
+
+```typescript
+createChangePasswordMessage(username: string, oldPassword: string, newPassword: string): Message<MessageDetails.ChangePassword>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  username | string |  |
+|  oldPassword | string |  |
+|  newPassword | string |  |
+
+**Returns:**
+
+[Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.ChangePassword](./foundation-comms.messagedetails.changepassword.md)<!-- -->&gt;
+

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

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

package/docs/api/foundation-comms.defaultmessagebuilder.createdatalogonmessage.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; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createDataLogonMessage](./foundation-comms.defaultmessagebuilder.createdatalogonmessage.md)
+
+## DefaultMessageBuilder.createDataLogonMessage() method
+
+**Signature:**
+
+```typescript
+createDataLogonMessage(resourceName: string, params?: any): Message<MessageDetails.DataserverRequest>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  resourceName | string |  |
+|  params | any | _(Optional)_ |
+
+**Returns:**
+
+[Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.DataserverRequest](./foundation-comms.messagedetails.dataserverrequest.md)<!-- -->&gt;
+

package/docs/api/foundation-comms.defaultmessagebuilder.createforgotpasswordmessage.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; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createForgotPasswordMessage](./foundation-comms.defaultmessagebuilder.createforgotpasswordmessage.md)
+
+## DefaultMessageBuilder.createForgotPasswordMessage() method
+
+**Signature:**
+
+```typescript
+createForgotPasswordMessage(username: string, returnUrl: string, requester?: string): Message<MessageDetails.ForgotPassword>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  username | string |  |
+|  returnUrl | string |  |
+|  requester | string | _(Optional)_ |
+
+**Returns:**
+
+[Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.ForgotPassword](./foundation-comms.messagedetails.forgotpassword.md)<!-- -->&gt;
+

package/docs/api/foundation-comms.defaultmessagebuilder.createforgotpasswordtokenmessage.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; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createForgotPasswordTokenMessage](./foundation-comms.defaultmessagebuilder.createforgotpasswordtokenmessage.md)
+
+## DefaultMessageBuilder.createForgotPasswordTokenMessage() method
+
+**Signature:**
+
+```typescript
+createForgotPasswordTokenMessage(username: string, resetToken: string, newPassword: string, requester?: string): Message<MessageDetails.ForgotPasswordToken>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  username | string |  |
+|  resetToken | string |  |
+|  newPassword | string |  |
+|  requester | string | _(Optional)_ |
+
+**Returns:**
+
+[Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.ForgotPasswordToken](./foundation-comms.messagedetails.forgotpasswordtoken.md)<!-- -->&gt;
+

package/docs/api/foundation-comms.defaultmessagebuilder.createhttpheadersfrommessage.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; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createHTTPHeadersFromMessage](./foundation-comms.defaultmessagebuilder.createhttpheadersfrommessage.md)
+
+## DefaultMessageBuilder.createHTTPHeadersFromMessage() method
+
+**Signature:**
+
+```typescript
+createHTTPHeadersFromMessage(message: Message, contentType?: string): HeadersInit;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  message | [Message](./foundation-comms.message.md) |  |
+|  contentType | string | _(Optional)_ |
+
+**Returns:**
+
+HeadersInit
+

package/docs/api/foundation-comms.defaultmessagebuilder.createloginmessage.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; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createLoginMessage](./foundation-comms.defaultmessagebuilder.createloginmessage.md)
+
+## DefaultMessageBuilder.createLoginMessage() method
+
+**Signature:**
+
+```typescript
+createLoginMessage(credentials: AuthInfo): Message<MessageDetails.Login>;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  credentials | [AuthInfo](./foundation-comms.authinfo.md) |  |
+
+**Returns:**
+
+[Message](./foundation-comms.message.md)<!-- -->&lt;[MessageDetails.Login](./foundation-comms.messagedetails.login.md)<!-- -->&gt;
+

package/docs/api/foundation-comms.defaultmessagebuilder.createlogoutmessage.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; [DefaultMessageBuilder](./foundation-comms.defaultmessagebuilder.md) &gt; [createLogoutMessage](./foundation-comms.defaultmessagebuilder.createlogoutmessage.md)
+
+## DefaultMessageBuilder.createLogoutMessage() method
+
+**Signature:**
+
+```typescript
+createLogoutMessage(loginResult?: LoginResult): Message;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  loginResult | [LoginResult](./foundation-comms.loginresult.md) | _(Optional)_ |
+
+**Returns:**
+
+[Message](./foundation-comms.message.md)
+

package/docs/api/foundation-comms.defaultmessagebuilder.createmetarequestmessage.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; [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

@@ -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; [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

@@ -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; [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

@@ -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; [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

@@ -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; [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

@@ -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; [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

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

@@ -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; [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

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

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

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

@@ -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; [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

@@ -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; [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

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