@genesislcap/foundation-comms 14.302.0 → 14.302.1-alpha-d11831b.0

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

@@ -0,0 +1,137 @@
+<!-- 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
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[base64?](./foundation-comms.keyvalue.base64.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+**_(ALPHA)_** _(Optional)_ Value should be encoded.
+
+
+</td></tr>
+<tr><td>
+
+[expiration?](./foundation-comms.keyvalue.expiration.md)
+
+
+</td><td>
+
+
+</td><td>
+
+number
+
+
+</td><td>
+
+**_(ALPHA)_** _(Optional)_ Time key expires.
+
+
+</td></tr>
+<tr><td>
+
+[key](./foundation-comms.keyvalue.key.md)
+
+
+</td><td>
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+**_(ALPHA)_** Key
+
+
+</td></tr>
+<tr><td>
+
+[metadata?](./foundation-comms.keyvalue.metadata.md)
+
+
+</td><td>
+
+
+</td><td>
+
+{ \[key: string\]: unknown; }
+
+
+</td><td>
+
+**_(ALPHA)_** _(Optional)_ Additional metadata.
+
+
+</td></tr>
+<tr><td>
+
+[value?](./foundation-comms.keyvalue.value.md)
+
+
+</td><td>
+
+
+</td><td>
+
+T
+
+
+</td><td>
+
+**_(ALPHA)_** _(Optional)_ Value
+
+
+</td></tr>
+</tbody></table>
+

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

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

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

@@ -0,0 +1,53 @@
+<!-- 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
+
+<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:**
+
+Promise&lt;T&gt;
+

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

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

@@ -0,0 +1,98 @@
+<!-- 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
+
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[kv](./foundation-comms.keyvaluetransfer.kv.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[KeyValue](./foundation-comms.keyvalue.md)<!-- -->&lt;T&gt;
+
+
+</td><td>
+
+**_(ALPHA)_**
+
+
+</td></tr>
+</tbody></table>
+
+## Methods
+
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[deserialize(value)?](./foundation-comms.keyvaluetransfer.deserialize.md)
+
+
+</td><td>
+
+**_(ALPHA)_** _(Optional)_
+
+
+</td></tr>
+<tr><td>
+
+[serialize(value)?](./foundation-comms.keyvaluetransfer.serialize.md)
+
+
+</td><td>
+
+**_(ALPHA)_** _(Optional)_
+
+
+</td></tr>
+</tbody></table>
+

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

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

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

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

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

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

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

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

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