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

package/docs/api/foundation-comms.kvstorage.get_1.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; [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
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  key | string |  |
-
-**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,31 +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
-
-|  Method | Description |
-|  --- | --- |
-|  [delete(keys)](./foundation-comms.kvstorage.delete.md) | **_(ALPHA)_** |
-|  [get()](./foundation-comms.kvstorage.get.md) | **_(ALPHA)_** |
-|  [get(key)](./foundation-comms.kvstorage.get_1.md) | **_(ALPHA)_** |
-|  [list()](./foundation-comms.kvstorage.list.md) | **_(ALPHA)_** |
-|  [put(kvs)](./foundation-comms.kvstorage.put.md) | **_(ALPHA)_** |
-

package/docs/api/foundation-comms.kvstorage.put.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; [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
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  kvs | [KeyValue](./foundation-comms.keyvalue.md)<!-- -->&lt;[KVValue](./foundation-comms.kvvalue.md)<!-- -->&gt;\[\] |  |
-
-**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,26 +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
-
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [account?](./foundation-comms.kvstorageconfig.account.md) |  | string | **_(ALPHA)_** _(Optional)_ The account id to use. |
-|  [authEmail?](./foundation-comms.kvstorageconfig.authemail.md) |  | string | **_(ALPHA)_** _(Optional)_ Access control auth email. |
-|  [authKey?](./foundation-comms.kvstorageconfig.authkey.md) |  | string | **_(ALPHA)_** _(Optional)_ Access control auth key. |
-|  [namespace?](./foundation-comms.kvstorageconfig.namespace.md) |  | string | **_(ALPHA)_** _(Optional)_ The namespace to use. |
-

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;
-```

package/docs/api/foundation-comms.kvvalue.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; [KVValue](./foundation-comms.kvvalue.md)
-
-## KVValue 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.
-> 
-
-KVValue type.
-
-**Signature:**
-
-```typescript
-export type KVValue = string | ArrayBuffer;
-```

package/docs/api/foundation-comms.socket.sendforstreamwithoutteardown.md

@@ -1,31 +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; [Socket](./foundation-comms.socket.md) &gt; [sendForStreamWithoutTeardown](./foundation-comms.socket.sendforstreamwithoutteardown.md)
-
-## Socket.sendForStreamWithoutTeardown() 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.
-> 
-
-Sends a message and returns an observable that emits messages received from the server.
-
-**Signature:**
-
-```typescript
-sendForStreamWithoutTeardown<T>(message: Message<T | any>, onMessage: Function, onError: Function): Observable<Message>;
-```
-
-## Parameters
-
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  message | [Message](./foundation-comms.message.md)<!-- -->&lt;T \| any&gt; | The message to send. |
-|  onMessage | Function | The function to call when a message is received. |
-|  onError | Function | The function to call when an error is received. |
-
-**Returns:**
-
-Observable&lt;[Message](./foundation-comms.message.md)<!-- -->&gt;
-
-An observable that emits messages received from the server.
-