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

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

@@ -1,312 +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; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md)
-
-## DefaultEntityDatasource class
-
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-Default EntityDatasource DI implementation.
-
-**Signature:**
-
-```typescript
-export declare class DefaultEntityDatasource<TDTO, TEntity> extends DefaultDatasource implements EntityDatasource<TDTO, TEntity> 
-```
-**Extends:** [DefaultDatasource](./foundation-comms.defaultdatasource.md)
-
-**Implements:** [EntityDatasource](./foundation-comms.entitydatasource.md)<!-- -->&lt;TDTO, TEntity&gt;
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[\_initialized](./foundation-comms.defaultentitydatasource._initialized.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[cache](./foundation-comms.defaultentitydatasource.cache.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-TEntity\[\]
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[disconnect](./foundation-comms.defaultentitydatasource.disconnect.md)
-
-
-</td><td>
-
-
-</td><td>
-
-() =&gt; void
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[entityCache](./foundation-comms.defaultentitydatasource.entitycache.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-TEntity\[\]
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[entityMap](./foundation-comms.defaultentitydatasource.entitymap.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-Map&lt;string, TEntity&gt;
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[initialize](./foundation-comms.defaultentitydatasource.initialize.md)
-
-
-</td><td>
-
-
-</td><td>
-
-(init: [EntityDatasourceInit](./foundation-comms.entitydatasourceinit.md)<!-- -->&lt;TDTO, TEntity&gt;) =&gt; Promise&lt;boolean&gt;
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[initialized](./foundation-comms.defaultentitydatasource.initialized.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[isEmpty](./foundation-comms.defaultentitydatasource.isempty.md)
-
-
-</td><td>
-
-`readonly`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[mapper](./foundation-comms.defaultentitydatasource.mapper.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-DTOMapper&lt;TDTO, TEntity&gt;
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[rowId](./foundation-comms.defaultentitydatasource.rowid.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[sourceRef](./foundation-comms.defaultentitydatasource.sourceref.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[subscription](./foundation-comms.defaultentitydatasource.subscription.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-SocketSubscription
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[subscriptionLoggedOff](./foundation-comms.defaultentitydatasource.subscriptionloggedoff.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-comms.defaultentitydatasource.rowid.md

@@ -1,14 +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; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [rowId](./foundation-comms.defaultentitydatasource.rowid.md)
-
-## DefaultEntityDatasource.rowId property
-
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-**Signature:**
-
-```typescript
-protected rowId: string;
-```

package/docs/api/foundation-comms.defaultentitydatasource.sourceref.md

@@ -1,14 +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; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [sourceRef](./foundation-comms.defaultentitydatasource.sourceref.md)
-
-## DefaultEntityDatasource.sourceRef property
-
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-**Signature:**
-
-```typescript
-protected sourceRef: string;
-```

package/docs/api/foundation-comms.defaultentitydatasource.subscription.md

@@ -1,14 +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; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [subscription](./foundation-comms.defaultentitydatasource.subscription.md)
-
-## DefaultEntityDatasource.subscription property
-
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-**Signature:**
-
-```typescript
-protected subscription: SocketSubscription;
-```

package/docs/api/foundation-comms.defaultentitydatasource.subscriptionloggedoff.md

@@ -1,14 +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; [DefaultEntityDatasource](./foundation-comms.defaultentitydatasource.md) &gt; [subscriptionLoggedOff](./foundation-comms.defaultentitydatasource.subscriptionloggedoff.md)
-
-## DefaultEntityDatasource.subscriptionLoggedOff property
-
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-**Signature:**
-
-```typescript
-protected subscriptionLoggedOff: boolean;
-```

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

@@ -1,81 +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; [DefaultKVStorage](./foundation-comms.defaultkvstorage.md) &gt; [(constructor)](./foundation-comms.defaultkvstorage._constructor_.md)
-
-## DefaultKVStorage.(constructor)
-
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-Constructs a new instance of the `DefaultKVStorage` class
-
-**Signature:**
-
-```typescript
-constructor(connect: Connect, user: User, kvStorageConfig?: KVStorageConfig);
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-connect
-
-
-</td><td>
-
-[Connect](./foundation-comms.connect.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-user
-
-
-</td><td>
-
-User
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-kvStorageConfig
-
-
-</td><td>
-
-[KVStorageConfig](./foundation-comms.kvstorageconfig.md)
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -1,98 +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; [DefaultKVStorage](./foundation-comms.defaultkvstorage.md)
-
-## DefaultKVStorage class
-
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-The default implementation for the KVStorage interface.
-
-**Signature:**
-
-```typescript
-export declare class DefaultKVStorage implements KVStorage 
-```
-**Implements:** [KVStorage](./foundation-comms.kvstorage.md)
-
-## Constructors
-
-<table><thead><tr><th>
-
-Constructor
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[(constructor)(connect, user, kvStorageConfig)](./foundation-comms.defaultkvstorage._constructor_.md)
-
-
-</td><td>
-
-
-</td><td>
-
-**_(ALPHA)_** Constructs a new instance of the `DefaultKVStorage` class
-
-
-</td></tr>
-</tbody></table>
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[user](./foundation-comms.defaultkvstorage.user.md)
-
-
-</td><td>
-
-`protected`
-
-
-</td><td>
-
-User
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-comms.defaultkvstorage.user.md

@@ -1,14 +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; [DefaultKVStorage](./foundation-comms.defaultkvstorage.md) &gt; [user](./foundation-comms.defaultkvstorage.user.md)
-
-## DefaultKVStorage.user property
-
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-**Signature:**
-
-```typescript
-protected user: User;
-```

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

@@ -1,16 +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; [defaultKVStorageConfig](./foundation-comms.defaultkvstorageconfig.md)
-
-## defaultKVStorageConfig variable
-
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-The default configuration for the KVStorage service.
-
-**Signature:**
-
-```typescript
-defaultKVStorageConfig: KVStorageConfig
-```

package/docs/api/foundation-comms.entitydatasource.cache.md

@@ -1,19 +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; [EntityDatasource](./foundation-comms.entitydatasource.md) &gt; [cache](./foundation-comms.entitydatasource.cache.md)
-
-## EntityDatasource.cache property
-
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-**Signature:**
-
-```typescript
-readonly cache: TEntity[];
-```
-
-## Remarks
-
-In-memory entity cache.
-

package/docs/api/foundation-comms.entitydatasource.disconnect.md

@@ -1,22 +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; [EntityDatasource](./foundation-comms.entitydatasource.md) &gt; [disconnect](./foundation-comms.entitydatasource.disconnect.md)
-
-## EntityDatasource.disconnect() method
-
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-**Signature:**
-
-```typescript
-disconnect(): void;
-```
-**Returns:**
-
-void
-
-## Remarks
-
-Disconnect and reset cache.
-

package/docs/api/foundation-comms.entitydatasource.initialize.md

@@ -1,57 +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; [EntityDatasource](./foundation-comms.entitydatasource.md) &gt; [initialize](./foundation-comms.entitydatasource.initialize.md)
-
-## EntityDatasource.initialize() method
-
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-**Signature:**
-
-```typescript
-initialize(init: EntityDatasourceInit<TDTO, TEntity>): Promise<boolean>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-init
-
-
-</td><td>
-
-[EntityDatasourceInit](./foundation-comms.entitydatasourceinit.md)<!-- -->&lt;TDTO, TEntity&gt;
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;boolean&gt;
-
-## Remarks
-
-Initialize datasource.
-

package/docs/api/foundation-comms.entitydatasource.isempty.md

@@ -1,19 +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; [EntityDatasource](./foundation-comms.entitydatasource.md) &gt; [isEmpty](./foundation-comms.entitydatasource.isempty.md)
-
-## EntityDatasource.isEmpty property
-
-> This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
-> 
-
-**Signature:**
-
-```typescript
-readonly isEmpty: boolean;
-```
-
-## Remarks
-
-Cache is empty / awaiting first result.
-