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

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

@@ -1,53 +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
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-value
-
-
-</td><td>
-
-unknown
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**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,69 +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
-
-<table><thead><tr><th>
-
-Member
-
-
-</th><th>
-
-Value
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-EVENT\_KEY\_VALUE\_DELETE
-
-
-</td><td>
-
-`"EVENT_KEY_VALUE_DELETE"`
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-EVENT\_KEY\_VALUE\_PUT
-
-
-</td><td>
-
-`"EVENT_KEY_VALUE_PUT"`
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -1,69 +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
-
-<table><thead><tr><th>
-
-Member
-
-
-</th><th>
-
-Value
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-REQ\_KEY\_VALUE\_LIST
-
-
-</td><td>
-
-`"REQ_KEY_VALUE_LIST"`
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-REQ\_KEY\_VALUE\_READ
-
-
-</td><td>
-
-`"REQ_KEY_VALUE_READ"`
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-comms.kvstorage.delete.md

@@ -1,53 +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
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-keys
-
-
-</td><td>
-
-string\[\]
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**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;
-

package/docs/api/foundation-comms.kvstorage.get_1.md

@@ -1,53 +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_1.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>(key: string): Promise<KeyValueTransfer<T>>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-key
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;[KeyValueTransfer](./foundation-comms.keyvaluetransfer.md)<!-- -->&lt;T&gt;&gt;
-

package/docs/api/foundation-comms.kvstorage.list.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; [list](./foundation-comms.kvstorage.list.md)
-
-## KVStorage.list() 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
-list(): Promise<string[]>;
-```
-**Returns:**
-
-Promise&lt;string\[\]&gt;
-

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

@@ -1,91 +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)
-
-## KVStorage 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.
-> 
-
-Represents a KV (key-value) data storage and its capabilities. Provides methods to set and get items from the KV data storage.
-
-**Signature:**
-
-```typescript
-export interface KVStorage 
-```
-
-## Remarks
-
-Provides a key value storage api that abstracts the underlying storage technology.
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[delete(keys)](./foundation-comms.kvstorage.delete.md)
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[get()](./foundation-comms.kvstorage.get.md)
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[get(key)](./foundation-comms.kvstorage.get_1.md)
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[list()](./foundation-comms.kvstorage.list.md)
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-<tr><td>
-
-[put(kvs)](./foundation-comms.kvstorage.put.md)
-
-
-</td><td>
-
-**_(ALPHA)_**
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-comms.kvstorage.put.md

@@ -1,53 +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; [put](./foundation-comms.kvstorage.put.md)
-
-## KVStorage.put() 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
-put(kvs: KeyValue<KVValue>[]): Promise<true | KVEventFailureResponse>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-kvs
-
-
-</td><td>
-
-[KeyValue](./foundation-comms.keyvalue.md)<!-- -->&lt;[KVValue](./foundation-comms.kvvalue.md)<!-- -->&gt;\[\]
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;true \| [KVEventFailureResponse](./foundation-comms.kveventfailureresponse.md)<!-- -->&gt;
-

package/docs/api/foundation-comms.kvstorageconfig.account.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; [KVStorageConfig](./foundation-comms.kvstorageconfig.md) &gt; [account](./foundation-comms.kvstorageconfig.account.md)
-
-## KVStorageConfig.account 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.
-> 
-
-The account id to use.
-
-**Signature:**
-
-```typescript
-account?: string;
-```

package/docs/api/foundation-comms.kvstorageconfig.authemail.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; [KVStorageConfig](./foundation-comms.kvstorageconfig.md) &gt; [authEmail](./foundation-comms.kvstorageconfig.authemail.md)
-
-## KVStorageConfig.authEmail 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.
-> 
-
-Access control auth email.
-
-**Signature:**
-
-```typescript
-authEmail?: string;
-```
-
-## Remarks
-
-Part of access requirements and where to report integration issues.
-

package/docs/api/foundation-comms.kvstorageconfig.authkey.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; [KVStorageConfig](./foundation-comms.kvstorageconfig.md) &gt; [authKey](./foundation-comms.kvstorageconfig.authkey.md)
-
-## KVStorageConfig.authKey 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.
-> 
-
-Access control auth key.
-
-**Signature:**
-
-```typescript
-authKey?: string;
-```

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

@@ -1,118 +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; [KVStorageConfig](./foundation-comms.kvstorageconfig.md)
-
-## KVStorageConfig 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.
-> 
-
-KVStorageConfig DI interface.
-
-**Signature:**
-
-```typescript
-export interface KVStorageConfig 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[account?](./foundation-comms.kvstorageconfig.account.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(ALPHA)_** _(Optional)_ The account id to use.
-
-
-</td></tr>
-<tr><td>
-
-[authEmail?](./foundation-comms.kvstorageconfig.authemail.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(ALPHA)_** _(Optional)_ Access control auth email.
-
-
-</td></tr>
-<tr><td>
-
-[authKey?](./foundation-comms.kvstorageconfig.authkey.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(ALPHA)_** _(Optional)_ Access control auth key.
-
-
-</td></tr>
-<tr><td>
-
-[namespace?](./foundation-comms.kvstorageconfig.namespace.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-**_(ALPHA)_** _(Optional)_ The namespace to use.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/foundation-comms.kvstorageconfig.namespace.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; [KVStorageConfig](./foundation-comms.kvstorageconfig.md) &gt; [namespace](./foundation-comms.kvstorageconfig.namespace.md)
-
-## KVStorageConfig.namespace 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.
-> 
-
-The namespace to use.
-
-**Signature:**
-
-```typescript
-namespace?: string;
-```