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

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

@@ -14,18 +14,149 @@ export declare class GenesisResourcesMock implements GenesisResources
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [nextIsValidResourceResponse](./foundation-comms.genesisresourcesmock.nextisvalidresourceresponse.md) |  | boolean |  |
-|  [nextResourceTypeForResponse](./foundation-comms.genesisresourcesmock.nextresourcetypeforresponse.md) |  | [ResourceType](./foundation-comms.resourcetype.md) |  |
-|  [resources](./foundation-comms.genesisresourcesmock.resources.md) |  | [ResourceItem](./foundation-comms.resourceitem.md)<!-- -->\[\] |  |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[nextIsValidResourceResponse](./foundation-comms.genesisresourcesmock.nextisvalidresourceresponse.md)
+
+
+</td><td>
+
+
+</td><td>
+
+boolean
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[nextResourceTypeForResponse](./foundation-comms.genesisresourcesmock.nextresourcetypeforresponse.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ResourceType](./foundation-comms.resourcetype.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[resources](./foundation-comms.genesisresourcesmock.resources.md)
+
+
+</td><td>
+
+
+</td><td>
+
+[ResourceItem](./foundation-comms.resourceitem.md)<!-- -->\[\]
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-|  Method | Modifiers | Description |
-|  --- | --- | --- |
-|  [destroy()](./foundation-comms.genesisresourcesmock.destroy.md) |  |  |
-|  [getAllResources()](./foundation-comms.genesisresourcesmock.getallresources.md) |  |  |
-|  [getResourceTypeFor(resourceName)](./foundation-comms.genesisresourcesmock.getresourcetypefor.md) |  | Gets the type of resource |
-|  [isValidResource(resourceName)](./foundation-comms.genesisresourcesmock.isvalidresource.md) |  | Checks if the resource exists |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[destroy()](./foundation-comms.genesisresourcesmock.destroy.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[getAllResources()](./foundation-comms.genesisresourcesmock.getallresources.md)
+
+
+</td><td>
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[getResourceTypeFor(resourceName)](./foundation-comms.genesisresourcesmock.getresourcetypefor.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Gets the type of resource
+
+
+</td></tr>
+<tr><td>
+
+[isValidResource(resourceName)](./foundation-comms.genesisresourcesmock.isvalidresource.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Checks if the resource exists
+
+
+</td></tr>
+</tbody></table>
 

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

@@ -13,7 +13,7 @@ export declare function getKVStorage(): KVStorage;
 ```
 **Returns:**
 
-KVStorage
+[KVStorage](./foundation-comms.kvstorage.md)
 
 ## Remarks
 

package/docs/api/foundation-comms.http.get.md

@@ -12,10 +12,51 @@ get<T = any>(url: string, requestInit: HttpRequestInit): Promise<T>;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  url | string |  |
-|  requestInit | [HttpRequestInit](./foundation-comms.httprequestinit.md) |  |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+url
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+requestInit
+
+
+</td><td>
+
+[HttpRequestInit](./foundation-comms.httprequestinit.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

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

@@ -14,8 +14,34 @@ export interface Http
 
 ## Methods
 
-|  Method | Description |
-|  --- | --- |
-|  [get(url, requestInit)](./foundation-comms.http.get.md) |  |
-|  [post(url, requestInit)](./foundation-comms.http.post.md) |  |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[get(url, requestInit)](./foundation-comms.http.get.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[post(url, requestInit)](./foundation-comms.http.post.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-comms.http.post.md

@@ -12,10 +12,51 @@ post<T = any>(url: string, requestInit: HttpRequestInit): Promise<T>;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  url | string |  |
-|  requestInit | [HttpRequestInit](./foundation-comms.httprequestinit.md) |  |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+url
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+requestInit
+
+
+</td><td>
+
+[HttpRequestInit](./foundation-comms.httprequestinit.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

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

@@ -15,7 +15,45 @@ export interface HttpRequestInit extends RequestInit
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [serializer?](./foundation-comms.httprequestinit.serializer.md) |  | JSONSerializer | _(Optional)_ A serializer function to transform the request body. |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[serializer?](./foundation-comms.httprequestinit.serializer.md)
+
+
+</td><td>
+
+
+</td><td>
+
+JSONSerializer
+
+
+</td><td>
+
+_(Optional)_ A serializer function to transform the request body.
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-comms.jsonschemacache.getjsonschemafor.md

@@ -12,9 +12,37 @@ getJsonSchemaFor(resourceName: string): SchemaResponse;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  resourceName | string |  |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+resourceName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-comms.jsonschemacache.hasjsonschemafor.md

@@ -12,9 +12,37 @@ hasJsonSchemaFor(resourceName: string): boolean;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  resourceName | string |  |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+resourceName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

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

@@ -14,15 +14,85 @@ export interface JsonSchemaCache
 
 ## Properties
 
-|  Property | Modifiers | Type | Description |
-|  --- | --- | --- | --- |
-|  [cachedJsonSchema](./foundation-comms.jsonschemacache.cachedjsonschema.md) |  | Map&lt;string, [SchemaResponse](./foundation-comms.schemaresponse.md)<!-- -->&gt; |  |
+<table><thead><tr><th>
+
+Property
+
+
+</th><th>
+
+Modifiers
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[cachedJsonSchema](./foundation-comms.jsonschemacache.cachedjsonschema.md)
+
+
+</td><td>
+
+
+</td><td>
+
+Map&lt;string, [SchemaResponse](./foundation-comms.schemaresponse.md)<!-- -->&gt;
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 ## Methods
 
-|  Method | Description |
-|  --- | --- |
-|  [getJsonSchemaFor(resourceName)](./foundation-comms.jsonschemacache.getjsonschemafor.md) |  |
-|  [hasJsonSchemaFor(resourceName)](./foundation-comms.jsonschemacache.hasjsonschemafor.md) |  |
-|  [setJsonSchemaFor(resourceName, schemaResponse)](./foundation-comms.jsonschemacache.setjsonschemafor.md) |  |
+<table><thead><tr><th>
+
+Method
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+[getJsonSchemaFor(resourceName)](./foundation-comms.jsonschemacache.getjsonschemafor.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[hasJsonSchemaFor(resourceName)](./foundation-comms.jsonschemacache.hasjsonschemafor.md)
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+[setJsonSchemaFor(resourceName, schemaResponse)](./foundation-comms.jsonschemacache.setjsonschemafor.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 

package/docs/api/foundation-comms.jsonschemacache.setjsonschemafor.md

@@ -12,10 +12,51 @@ setJsonSchemaFor(resourceName: string, schemaResponse: SchemaResponse): any;
 
 ## Parameters
 
-|  Parameter | Type | Description |
-|  --- | --- | --- |
-|  resourceName | string |  |
-|  schemaResponse | [SchemaResponse](./foundation-comms.schemaresponse.md) |  |
+<table><thead><tr><th>
+
+Parameter
+
+
+</th><th>
+
+Type
+
+
+</th><th>
+
+Description
+
+
+</th></tr></thead>
+<tbody><tr><td>
+
+resourceName
+
+
+</td><td>
+
+string
+
+
+</td><td>
+
+
+</td></tr>
+<tr><td>
+
+schemaResponse
+
+
+</td><td>
+
+[SchemaResponse](./foundation-comms.schemaresponse.md)
+
+
+</td><td>
+
+
+</td></tr>
+</tbody></table>
 
 **Returns:**
 

package/docs/api/foundation-comms.keyvalue.base64.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; [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

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

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