@genesislcap/foundation-comms 14.237.2-alpha-78ebbc0.0 → 14.238.0

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

@@ -1,30 +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
-
-|  Constructor | Modifiers | Description |
-|  --- | --- | --- |
-|  [(constructor)(connect, user, kvStorageConfig)](./foundation-comms.defaultkvstorage._constructor_.md) |  | **_(ALPHA)_** Constructs a new instance of the <code>DefaultKVStorage</code> class |
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [user](./foundation-comms.defaultkvstorage.user.md) | <code>protected</code> | User | **_(ALPHA)_** |
-

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,29 +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
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  init | [EntityDatasourceInit](./foundation-comms.entitydatasourceinit.md)<!-- -->&lt;TDTO, TEntity&gt; |  |
-
-**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.
-

package/docs/api/foundation-comms.entitydatasource.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; [EntityDatasource](./foundation-comms.entitydatasource.md)
-
-## EntityDatasource interface
-
-> 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.
-> 
-
-EntityDatasource DI interface.
-
-**Signature:**
-
-```typescript
-export interface EntityDatasource<TDTO, TEntity> extends Datasource 
-```
-**Extends:** [Datasource](./foundation-comms.datasource.md)
-
-## Remarks
-
-A simple streaming datasource cache used mainly by services that employ DTO mappers.
-
-## Example
-
-An example service using an underlying EntityDatasource:
-
-```ts
-export class DefaultDomainService implements DomainService {
-  constructor(
-    @EntityDatasource protected datasource: EntityDatasource<DomainDTO, DomainEntity>,
-    @DomainDTOMapper protected mapper: DomainDTOMapper,
-    @optional(DomainServiceConfig) private config = defaultConfig
-  ) {}
-
-  get initialized = () {
-    return this.datasource.initialized;
-  }
-
-  initialize = async (init) => {
-    await this.datasource.initialize({
-      mapper: this.mapper,
-      options: {
-        resourceName: this.config.resourceName,
-        ...init,
-      },
-    });
-    return this.initialized;
-  };
-
-  list = () => this.datasource.cache;
-
-  get = async (id: string) => this.datasource.cache.find((entity) => entity.id === id);
-
-  action = async (id: string, message?: string): Promise<Message> => {
-    return this.commitEvent('EVENT_DOMAIN_ACTION', { id, message });
-  };
-
-  private async commitEvent(event: string, entity: Partial<DomainEntity>) {
-    const msg = await this.connect.commitEvent(event, {
-      DETAILS: this.mapper.toDTO(entity),
-      IGNORE_WARNINGS: true,
-      VALIDATE: false,
-    });
-    return messageOrThrow(msg);
-  }
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [cache](./foundation-comms.entitydatasource.cache.md) | <code>readonly</code> | TEntity\[\] | **_(ALPHA)_** |
-|  [isEmpty](./foundation-comms.entitydatasource.isempty.md) | <code>readonly</code> | boolean | **_(ALPHA)_** |
-
-## Methods
-
-|  Method | Description |
-|  --- | --- |
-|  [disconnect()](./foundation-comms.entitydatasource.disconnect.md) | **_(ALPHA)_** |
-|  [initialize(init)](./foundation-comms.entitydatasource.initialize.md) | **_(ALPHA)_** |
-

package/docs/api/foundation-comms.entitydatasourceinit.fetchmeta.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; [EntityDatasourceInit](./foundation-comms.entitydatasourceinit.md) &gt; [fetchMeta](./foundation-comms.entitydatasourceinit.fetchmeta.md)
-
-## EntityDatasourceInit.fetchMeta 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
-fetchMeta?: boolean;
-```

package/docs/api/foundation-comms.entitydatasourceinit.mapper.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; [EntityDatasourceInit](./foundation-comms.entitydatasourceinit.md) &gt; [mapper](./foundation-comms.entitydatasourceinit.mapper.md)
-
-## EntityDatasourceInit.mapper 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
-mapper: DTOMapper<TDTO, TEntity>;
-```

package/docs/api/foundation-comms.entitydatasourceinit.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; [EntityDatasourceInit](./foundation-comms.entitydatasourceinit.md)
-
-## EntityDatasourceInit interface
-
-> 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.
-> 
-
-EntityDatasourceInit interface.
-
-**Signature:**
-
-```typescript
-export interface EntityDatasourceInit<TDTO, TEntity> 
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [fetchMeta?](./foundation-comms.entitydatasourceinit.fetchmeta.md) |  | boolean | **_(ALPHA)_** _(Optional)_ |
-|  [mapper](./foundation-comms.entitydatasourceinit.mapper.md) |  | DTOMapper&lt;TDTO, TEntity&gt; | **_(ALPHA)_** |
-|  [options](./foundation-comms.entitydatasourceinit.options.md) |  | Omit&lt;[DatasourceOptions](./foundation-comms.datasourceoptions.md)<!-- -->, 'isSnapshot'&gt; | **_(ALPHA)_** |
-

package/docs/api/foundation-comms.entitydatasourceinit.options.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; [EntityDatasourceInit](./foundation-comms.entitydatasourceinit.md) &gt; [options](./foundation-comms.entitydatasourceinit.options.md)
-
-## EntityDatasourceInit.options 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
-options: Omit<DatasourceOptions, 'isSnapshot'>;
-```

package/docs/api/foundation-comms.keyvalue.base64.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; [KeyValue](./foundation-comms.keyvalue.md) &gt; [base64](./foundation-comms.keyvalue.base64.md)
-
-## KeyValue.base64 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.
-> 
-
-Value should be encoded.
-
-**Signature:**
-
-```typescript
-base64?: boolean;
-```

package/docs/api/foundation-comms.keyvalue.expiration.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; [KeyValue](./foundation-comms.keyvalue.md) &gt; [expiration](./foundation-comms.keyvalue.expiration.md)
-
-## KeyValue.expiration 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.
-> 
-
-Time key expires.
-
-**Signature:**
-
-```typescript
-expiration?: number;
-```

package/docs/api/foundation-comms.keyvalue.key.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; [KeyValue](./foundation-comms.keyvalue.md) &gt; [key](./foundation-comms.keyvalue.key.md)
-
-## KeyValue.key 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.
-> 
-
-Key
-
-**Signature:**
-
-```typescript
-key: string;
-```

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

@@ -1,27 +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; [KeyValue](./foundation-comms.keyvalue.md)
-
-## KeyValue interface
-
-> 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.
-> 
-
-KeyValue interface.
-
-**Signature:**
-
-```typescript
-export interface KeyValue<T = KVValue> 
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [base64?](./foundation-comms.keyvalue.base64.md) |  | boolean | **_(ALPHA)_** _(Optional)_ Value should be encoded. |
-|  [expiration?](./foundation-comms.keyvalue.expiration.md) |  | number | **_(ALPHA)_** _(Optional)_ Time key expires. |
-|  [key](./foundation-comms.keyvalue.key.md) |  | string | **_(ALPHA)_** Key |
-|  [metadata?](./foundation-comms.keyvalue.metadata.md) |  | { \[key: string\]: unknown; } | **_(ALPHA)_** _(Optional)_ Additional metadata. |
-|  [value?](./foundation-comms.keyvalue.value.md) |  | T | **_(ALPHA)_** _(Optional)_ Value |
-

package/docs/api/foundation-comms.keyvalue.metadata.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; [KeyValue](./foundation-comms.keyvalue.md) &gt; [metadata](./foundation-comms.keyvalue.metadata.md)
-
-## KeyValue.metadata 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.
-> 
-
-Additional metadata.
-
-**Signature:**
-
-```typescript
-metadata?: {
-        [key: string]: unknown;
-    };
-```

package/docs/api/foundation-comms.keyvalue.value.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; [KeyValue](./foundation-comms.keyvalue.md) &gt; [value](./foundation-comms.keyvalue.value.md)
-
-## KeyValue.value 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.
-> 
-
-Value
-
-**Signature:**
-
-```typescript
-value?: T;
-```

package/docs/api/foundation-comms.keyvaluetransfer.deserialize.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; [KeyValueTransfer](./foundation-comms.keyvaluetransfer.md) &gt; [deserialize](./foundation-comms.keyvaluetransfer.deserialize.md)
-
-## KeyValueTransfer.deserialize() 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
-deserialize?(value: unknown): Promise<T>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  value | unknown |  |
-
-**Returns:**
-
-Promise&lt;T&gt;
-

package/docs/api/foundation-comms.keyvaluetransfer.kv.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; [KeyValueTransfer](./foundation-comms.keyvaluetransfer.md) &gt; [kv](./foundation-comms.keyvaluetransfer.kv.md)
-
-## KeyValueTransfer.kv 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
-kv: KeyValue<T>;
-```

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

@@ -1,30 +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; [KeyValueTransfer](./foundation-comms.keyvaluetransfer.md)
-
-## KeyValueTransfer interface
-
-> 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.
-> 
-
-KeyValueTransfer interface.
-
-**Signature:**
-
-```typescript
-export interface KeyValueTransfer<T> 
-```
-
-## Properties
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [kv](./foundation-comms.keyvaluetransfer.kv.md) |  | [KeyValue](./foundation-comms.keyvalue.md)<!-- -->&lt;T&gt; | **_(ALPHA)_** |
-
-## Methods
-
-|  Method | Description |
-|  --- | --- |
-|  [deserialize(value)?](./foundation-comms.keyvaluetransfer.deserialize.md) | **_(ALPHA)_** _(Optional)_ |
-|  [serialize(value)?](./foundation-comms.keyvaluetransfer.serialize.md) | **_(ALPHA)_** _(Optional)_ |
-

package/docs/api/foundation-comms.keyvaluetransfer.serialize.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; [KeyValueTransfer](./foundation-comms.keyvaluetransfer.md) &gt; [serialize](./foundation-comms.keyvaluetransfer.serialize.md)
-
-## KeyValueTransfer.serialize() 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
-serialize?(value: unknown): unknown;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  value | unknown |  |
-
-**Returns:**
-
-unknown
-

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

@@ -1,21 +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; [KVEventFailureResponse](./foundation-comms.kveventfailureresponse.md)
-
-## KVEventFailureResponse type
-
-> 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.
-> 
-
-KVStorage type.
-
-**Signature:**
-
-```typescript
-export type KVEventFailureResponse = {
-    ERROR?: MessageError[];
-    WARNING: any[];
-};
-```
-**References:** [MessageError](./foundation-comms.messageerror.md)
-

package/docs/api/foundation-comms.kveventmessagetype.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; [KVEventMessageType](./foundation-comms.kveventmessagetype.md)
-
-## KVEventMessageType enum
-
-> 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.
-> 
-
-KV Event Message types
-
-**Signature:**
-
-```typescript
-export declare enum KVEventMessageType 
-```
-
-## Enumeration Members
-
-|  Member | Value | Description |
-|  --- | --- | --- |
-|  EVENT\_KEY\_VALUE\_DELETE | <code>&quot;EVENT_KEY_VALUE_DELETE&quot;</code> | **_(ALPHA)_** |
-|  EVENT\_KEY\_VALUE\_PUT | <code>&quot;EVENT_KEY_VALUE_PUT&quot;</code> | **_(ALPHA)_** |
-

package/docs/api/foundation-comms.kvmessagetype.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; [KVMessageType](./foundation-comms.kvmessagetype.md)
-
-## KVMessageType enum
-
-> 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.
-> 
-
-KV Message types
-
-**Signature:**
-
-```typescript
-export declare enum KVMessageType 
-```
-
-## Enumeration Members
-
-|  Member | Value | Description |
-|  --- | --- | --- |
-|  REQ\_KEY\_VALUE\_LIST | <code>&quot;REQ_KEY_VALUE_LIST&quot;</code> | **_(ALPHA)_** |
-|  REQ\_KEY\_VALUE\_READ | <code>&quot;REQ_KEY_VALUE_READ&quot;</code> | **_(ALPHA)_** |
-

package/docs/api/foundation-comms.kvstorage.delete.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; [KVStorage](./foundation-comms.kvstorage.md) &gt; [delete](./foundation-comms.kvstorage.delete.md)
-
-## KVStorage.delete() 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
-delete(keys: string[]): Promise<true | KVEventFailureResponse>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  keys | string\[\] |  |
-
-**Returns:**
-
-Promise&lt;true \| [KVEventFailureResponse](./foundation-comms.kveventfailureresponse.md)<!-- -->&gt;
-

package/docs/api/foundation-comms.kvstorage.get.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; [KVStorage](./foundation-comms.kvstorage.md) &gt; [get](./foundation-comms.kvstorage.get.md)
-
-## KVStorage.get() 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
-get<T = KVValue>(): Promise<KeyValueTransfer<T>[]>;
-```
-**Returns:**
-
-Promise&lt;[KeyValueTransfer](./foundation-comms.keyvaluetransfer.md)<!-- -->&lt;T&gt;\[\]&gt;
-