@genesislcap/foundation-comms 14.408.0 → 14.409.0

package/docs/api/foundation-comms.session.setlocalstorageitem.md

@@ -1,70 +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; [Session](./foundation-comms.session.md) &gt; [setLocalStorageItem](./foundation-comms.session.setlocalstorageitem.md)
-
-## Session.setLocalStorageItem() method
-
-Sets an item in the local storage with the specified key and value.
-
-**Signature:**
-
-```typescript
-setLocalStorageItem(key: string | UserInfoKeys, value: string): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-key
-
-
-</td><td>
-
-string \| UserInfoKeys
-
-
-</td><td>
-
-The key to set.
-
-
-</td></tr>
-<tr><td>
-
-value
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The value to set.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

package/docs/api/foundation-comms.session.setsessionstorageitem.md

@@ -1,70 +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; [Session](./foundation-comms.session.md) &gt; [setSessionStorageItem](./foundation-comms.session.setsessionstorageitem.md)
-
-## Session.setSessionStorageItem() method
-
-Sets an item in the session storage with the specified key and value.
-
-**Signature:**
-
-```typescript
-setSessionStorageItem(key: string | UserInfoKeys, value: string): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-key
-
-
-</td><td>
-
-string \| UserInfoKeys
-
-
-</td><td>
-
-The key to set.
-
-
-</td></tr>
-<tr><td>
-
-value
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The value to set.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

package/docs/api/foundation-comms.session.setstoragekeyprefix.md

@@ -1,54 +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; [Session](./foundation-comms.session.md) &gt; [setStorageKeyPrefix](./foundation-comms.session.setstoragekeyprefix.md)
-
-## Session.setStorageKeyPrefix() method
-
-Sets the storage key prefix for the session.
-
-**Signature:**
-
-```typescript
-setStorageKeyPrefix(prefix: string): void;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-prefix
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-The prefix to set.
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-void
-

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

@@ -1,98 +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; [SessionRefreshResult](./foundation-comms.sessionrefreshresult.md)
-
-## SessionRefreshResult enum
-
-Result of a session refresh attempt.
-
-**Signature:**
-
-```typescript
-export declare enum SessionRefreshResult 
-```
-
-## Enumeration Members
-
-<table><thead><tr><th>
-
-Member
-
-
-</th><th>
-
-Value
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-ALREADY\_VALID
-
-
-</td><td>
-
-`"ALREADY_VALID"`
-
-
-</td><td>
-
-Session was already valid
-
-
-</td></tr>
-<tr><td>
-
-FAILED
-
-
-</td><td>
-
-`"FAILED"`
-
-
-</td><td>
-
-Refresh failed - page will reload
-
-
-</td></tr>
-<tr><td>
-
-HANDLED\_BY\_OTHER\_TAB
-
-
-</td><td>
-
-`"HANDLED_BY_OTHER_TAB"`
-
-
-</td><td>
-
-Another tab is handling the refresh
-
-
-</td></tr>
-<tr><td>
-
-SUCCESS
-
-
-</td><td>
-
-`"SUCCESS"`
-
-
-</td><td>
-
-Session was successfully refreshed
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -1,82 +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; [connect](./foundation-comms.socket.connect.md)
-
-## Socket.connect() method
-
-**Signature:**
-
-```typescript
-connect(host: string, options?: SocketConnectOptions, reconnectOptions?: SocketReconnectOptions): Promise<boolean>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-host
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-options
-
-
-</td><td>
-
-[SocketConnectOptions](./foundation-comms.socketconnectoptions.md)
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-<tr><td>
-
-reconnectOptions
-
-
-</td><td>
-
-[SocketReconnectOptions](./foundation-comms.socketreconnectoptions.md)
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;boolean&gt;
-

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

@@ -1,11 +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; [host](./foundation-comms.socket.host.md)
-
-## Socket.host property
-
-**Signature:**
-
-```typescript
-host: string;
-```

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

@@ -1,130 +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)
-
-## Socket interface
-
-Represents a WebSocket used to establish a communication channel between client and a Genesis server. Provides methods for socket connection, sending and receiving WS messages.
-
-**Signature:**
-
-```typescript
-export interface Socket extends Omit<SocketStatus, 'serialize' | 'onClose' | 'reconnectionLimitReached' | 'closedCode' | 'closedReason' | 'closedClean'> 
-```
-**Extends:** Omit&lt;[SocketStatus](./foundation-comms.socketstatus.md)<!-- -->, 'serialize' \| 'onClose' \| 'reconnectionLimitReached' \| 'closedCode' \| 'closedReason' \| 'closedClean'&gt;
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[host](./foundation-comms.socket.host.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-
-## Methods
-
-<table><thead><tr><th>
-
-Method
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[connect(host, options, reconnectOptions)](./foundation-comms.socket.connect.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[reset()](./foundation-comms.socket.reset.md)
-
-
-</td><td>
-
-Disconnects the socket and clears all subscriptions
-
-
-</td></tr>
-<tr><td>
-
-[send(message, needsHandling)](./foundation-comms.socket.send.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[sendForStream(message, onMessage, onError, onComplete)](./foundation-comms.socket.sendforstream.md)
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[sendForStreamWithoutTeardown(message, onMessage, onError)](./foundation-comms.socket.sendforstreamwithoutteardown.md)
-
-
-</td><td>
-
-**_(ALPHA)_** Sends a message and returns an observable that emits messages received from the server.
-
-
-</td></tr>
-<tr><td>
-
-[socketMessages()](./foundation-comms.socket.socketmessages.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

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

@@ -1,17 +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; [reset](./foundation-comms.socket.reset.md)
-
-## Socket.reset() method
-
-Disconnects the socket and clears all subscriptions
-
-**Signature:**
-
-```typescript
-reset(): void;
-```
-**Returns:**
-
-void
-

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

@@ -1,66 +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; [send](./foundation-comms.socket.send.md)
-
-## Socket.send() method
-
-**Signature:**
-
-```typescript
-send<T>(message: Message<T | any>, needsHandling?: boolean): Promise<Message | any>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-message
-
-
-</td><td>
-
-[Message](./foundation-comms.message.md)<!-- -->&lt;T \| any&gt;
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-needsHandling
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Promise&lt;[Message](./foundation-comms.message.md) \| any&gt;
-

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

@@ -1,94 +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; [sendForStream](./foundation-comms.socket.sendforstream.md)
-
-## Socket.sendForStream() method
-
-**Signature:**
-
-```typescript
-sendForStream<T>(message: Message<T | any>, onMessage: Function, onError: Function, onComplete?: Function): Observable<Message>;
-```
-
-## Parameters
-
-<table><thead><tr><th>
-
-Parameter
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-message
-
-
-</td><td>
-
-[Message](./foundation-comms.message.md)<!-- -->&lt;T \| any&gt;
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-onMessage
-
-
-</td><td>
-
-Function
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-onError
-
-
-</td><td>
-
-Function
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-onComplete
-
-
-</td><td>
-
-Function
-
-
-</td><td>
-
-_(Optional)_
-
-
-</td></tr>
-</tbody></table>
-
-**Returns:**
-
-Observable&lt;[Message](./foundation-comms.message.md)<!-- -->&gt;
-