@genesislcap/foundation-comms 14.291.2-alpha-39f1157.0 → 14.292.0

package/docs/api/foundation-comms.datasource.triggerpoll.md

@@ -1,17 +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; [Datasource](./foundation-comms.datasource.md) &gt; [triggerPoll](./foundation-comms.datasource.triggerpoll.md)
-
-## Datasource.triggerPoll() method
-
-Triggers a manual poll of the data source.
-
-**Signature:**
-
-```typescript
-triggerPoll(): void;
-```
-**Returns:**
-
-void
-

package/docs/api/foundation-comms.datasourceoptions.polltriggerevents.md

@@ -1,18 +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; [DatasourceOptions](./foundation-comms.datasourceoptions.md) &gt; [pollTriggerEvents](./foundation-comms.datasourceoptions.polltriggerevents.md)
-
-## DatasourceOptions.pollTriggerEvents property
-
-Array of event names that will trigger an additional poll.
-
-**Signature:**
-
-```typescript
-pollTriggerEvents?: string[];
-```
-
-## Remarks
-
-Only works with REQUEST\_SERVER resources.
-

package/docs/api/foundation-comms.defaultconnectevents.addcommitacklistener.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; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) &gt; [addCommitAckListener](./foundation-comms.defaultconnectevents.addcommitacklistener.md)
-
-## DefaultConnectEvents.addCommitAckListener() method
-
-Add a commit ack listener.
-
-**Signature:**
-
-```typescript
-addCommitAckListener(listener: Listener<CommitAckEvent>): () => void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  listener | Listener&lt;[CommitAckEvent](./foundation-comms.commitackevent.md)<!-- -->&gt; | A listener callback function. |
-
-**Returns:**
-
-() =&gt; void
-

package/docs/api/foundation-comms.defaultconnectevents.addcommitresponselistener.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; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) &gt; [addCommitResponseListener](./foundation-comms.defaultconnectevents.addcommitresponselistener.md)
-
-## DefaultConnectEvents.addCommitResponseListener() method
-
-Add a commit response listener (fires for both ack and nack).
-
-**Signature:**
-
-```typescript
-addCommitResponseListener(listener: Listener<CommitResponseEvent>): () => void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  listener | Listener&lt;[CommitResponseEvent](./foundation-comms.commitresponseevent.md)<!-- -->&gt; | A listener callback function. |
-
-**Returns:**
-
-() =&gt; void
-

package/docs/api/foundation-comms.defaultconnectevents.oncommitackevent.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; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) &gt; [onCommitAckEvent](./foundation-comms.defaultconnectevents.oncommitackevent.md)
-
-## DefaultConnectEvents.onCommitAckEvent() method
-
-Called by Connect when a commit ack is received.
-
-**Signature:**
-
-```typescript
-onCommitAckEvent(eventName: string, ack: Message): void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  eventName | string | The name of the event. |
-|  ack | [Message](./foundation-comms.message.md) | The ack message from the server. |
-
-**Returns:**
-
-void
-

package/docs/api/foundation-comms.defaultconnectevents.oncommitresponseevent.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; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) &gt; [onCommitResponseEvent](./foundation-comms.defaultconnectevents.oncommitresponseevent.md)
-
-## DefaultConnectEvents.onCommitResponseEvent() method
-
-Called by Connect when a commit response (ack or nack) is received.
-
-**Signature:**
-
-```typescript
-onCommitResponseEvent(eventName: string, response: Message): void;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  eventName | string | The name of the event. |
-|  response | [Message](./foundation-comms.message.md) | The response message from the server (ack or nack). |
-
-**Returns:**
-
-void
-

package/docs/api/foundation-comms.defaultdatasource.connectevents.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; [DefaultDatasource](./foundation-comms.defaultdatasource.md) &gt; [connectEvents](./foundation-comms.defaultdatasource.connectevents.md)
-
-## DefaultDatasource.connectEvents property
-
-**Signature:**
-
-```typescript
-protected connectEvents: ConnectEvents;
-```

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