@genesislcap/foundation-comms 14.185.0 → 14.186.0

package/dist/foundation-comms.api.json

@@ -2402,7 +2402,7 @@
             {
               "kind": "MethodSignature",
               "canonicalReference": "@genesislcap/foundation-comms!ConnectEvents#addStreamListener:member(1)",
-              "docComment": "/**\n * Add a stream listener.\n *\n * @param listener - A listener callback function.\n *\n * @param complete - A complete listener callback function.\n */\n",
+              "docComment": "/**\n * Add a stream listener.\n *\n * @param listener - A listener callback function.\n *\n * @param complete - A complete listener callback function.\n *\n * @param error - A error listener callback function.\n */\n",
               "excerptTokens": [
                 {
                   "kind": "Content",
@@ -2448,6 +2448,28 @@
                   "kind": "Content",
                   "text": ">"
                 },
+                {
+                  "kind": "Content",
+                  "text": ", error: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Listener",
+                  "canonicalReference": "@genesislcap/foundation-utils!Listener:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "StreamErrorEvent",
+                  "canonicalReference": "@genesislcap/foundation-comms!StreamErrorEvent:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">"
+                },
                 {
                   "kind": "Content",
                   "text": "): "
@@ -2463,8 +2485,8 @@
               ],
               "isOptional": false,
               "returnTypeTokenRange": {
-                "startIndex": 11,
-                "endIndex": 12
+                "startIndex": 16,
+                "endIndex": 17
               },
               "releaseTag": "Public",
               "overloadIndex": 1,
@@ -2484,6 +2506,14 @@
                     "endIndex": 10
                   },
                   "isOptional": false
+                },
+                {
+                  "parameterName": "error",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 11,
+                    "endIndex": 15
+                  },
+                  "isOptional": false
                 }
               ],
               "name": "addStreamListener"
@@ -2734,6 +2764,88 @@
               ],
               "name": "onStreamCompleteEvent"
             },
+            {
+              "kind": "MethodSignature",
+              "canonicalReference": "@genesislcap/foundation-comms!ConnectEventsEmitter#onStreamErrorEvent:member(1)",
+              "docComment": "/**\n * Called by Connect.\n *\n * @param resourceName - The name of the resource.\n *\n * @param stream - The actual stream itself.\n *\n * @param error - The error that occurred.\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "onStreamErrorEvent(resourceName: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", stream: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "SocketObservable",
+                  "canonicalReference": "@genesislcap/foundation-comms!SocketObservable:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<any>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", error: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isOptional": false,
+              "returnTypeTokenRange": {
+                "startIndex": 8,
+                "endIndex": 9
+              },
+              "releaseTag": "Public",
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "resourceName",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "stream",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 5
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "error",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 6,
+                    "endIndex": 7
+                  },
+                  "isOptional": false
+                }
+              ],
+              "name": "onStreamErrorEvent"
+            },
             {
               "kind": "MethodSignature",
               "canonicalReference": "@genesislcap/foundation-comms!ConnectEventsEmitter#onStreamEvent:member(1)",
@@ -8478,6 +8590,28 @@
                   "kind": "Content",
                   "text": ">"
                 },
+                {
+                  "kind": "Content",
+                  "text": ", error: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "Listener",
+                  "canonicalReference": "@genesislcap/foundation-utils!Listener:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<"
+                },
+                {
+                  "kind": "Reference",
+                  "text": "StreamErrorEvent",
+                  "canonicalReference": "@genesislcap/foundation-comms!StreamErrorEvent:type"
+                },
+                {
+                  "kind": "Content",
+                  "text": ">"
+                },
                 {
                   "kind": "Content",
                   "text": "): "
@@ -8493,8 +8627,8 @@
               ],
               "isStatic": false,
               "returnTypeTokenRange": {
-                "startIndex": 11,
-                "endIndex": 12
+                "startIndex": 16,
+                "endIndex": 17
               },
               "releaseTag": "Public",
               "isProtected": false,
@@ -8515,6 +8649,14 @@
                     "endIndex": 10
                   },
                   "isOptional": false
+                },
+                {
+                  "parameterName": "error",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 11,
+                    "endIndex": 15
+                  },
+                  "isOptional": false
                 }
               ],
               "isOptional": false,
@@ -8749,6 +8891,91 @@
               "isAbstract": false,
               "name": "onStreamCompleteEvent"
             },
+            {
+              "kind": "Method",
+              "canonicalReference": "@genesislcap/foundation-comms!DefaultConnectEvents#onStreamErrorEvent:member(1)",
+              "docComment": "/**\n * {@inheritDoc ConnectEventsEmitter.onStreamErrorEvent}\n */\n",
+              "excerptTokens": [
+                {
+                  "kind": "Content",
+                  "text": "onStreamErrorEvent(resourceName: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "string"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", stream: "
+                },
+                {
+                  "kind": "Reference",
+                  "text": "SocketObservable",
+                  "canonicalReference": "@genesislcap/foundation-comms!SocketObservable:class"
+                },
+                {
+                  "kind": "Content",
+                  "text": "<any>"
+                },
+                {
+                  "kind": "Content",
+                  "text": ", error: "
+                },
+                {
+                  "kind": "Content",
+                  "text": "any"
+                },
+                {
+                  "kind": "Content",
+                  "text": "): "
+                },
+                {
+                  "kind": "Content",
+                  "text": "void"
+                },
+                {
+                  "kind": "Content",
+                  "text": ";"
+                }
+              ],
+              "isStatic": false,
+              "returnTypeTokenRange": {
+                "startIndex": 8,
+                "endIndex": 9
+              },
+              "releaseTag": "Public",
+              "isProtected": false,
+              "overloadIndex": 1,
+              "parameters": [
+                {
+                  "parameterName": "resourceName",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 1,
+                    "endIndex": 2
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "stream",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 3,
+                    "endIndex": 5
+                  },
+                  "isOptional": false
+                },
+                {
+                  "parameterName": "error",
+                  "parameterTypeTokenRange": {
+                    "startIndex": 6,
+                    "endIndex": 7
+                  },
+                  "isOptional": false
+                }
+              ],
+              "isOptional": false,
+              "isAbstract": false,
+              "name": "onStreamErrorEvent"
+            },
             {
               "kind": "Method",
               "canonicalReference": "@genesislcap/foundation-comms!DefaultConnectEvents#onStreamEvent:member(1)",
@@ -21040,7 +21267,7 @@
         {
           "kind": "Variable",
           "canonicalReference": "@genesislcap/foundation-comms!messageHasErrorCode:var",
-          "docComment": "/**\n * Check if the message contains an error code.\n *\n * @param message - The message object.\n *\n * @param code - The error code.\n *\n * @public\n */\n",
+          "docComment": "/**\n * Check if the message contains an error code.\n *\n * @param message - The message object.\n *\n * @param code - The error code. Either a {@link http-status-codes#StatusCodes | StatusCodes} number or an entire status code string.\n *\n * @public\n */\n",
           "excerptTokens": [
             {
               "kind": "Content",
@@ -22917,7 +23144,7 @@
             },
             {
               "kind": "Content",
-              "text": ", 'MESSAGE_TYPE' | 'SOURCE_REF' | 'DETAILS'> & {\n    VERBOSE?: boolean;\n    [key: string]: any;\n}"
+              "text": ", 'MESSAGE_TYPE' | 'SOURCE_REF' | 'DETAILS' | 'SESSION_AUTH_TOKEN'> & {\n    VERBOSE?: boolean;\n    [key: string]: any;\n}"
             },
             {
               "kind": "Content",
@@ -25202,7 +25429,7 @@
               "text": ";"
             }
           ],
-          "fileUrlPath": "src/connect/socket.ts",
+          "fileUrlPath": "src/connect/socket.types.ts",
           "releaseTag": "Public",
           "name": "SocketConnectOptions",
           "typeTokenRange": {
@@ -26060,6 +26287,113 @@
             "endIndex": 0
           }
         },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-comms!StreamErrorEvent:type",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type StreamErrorEvent = "
+            },
+            {
+              "kind": "Reference",
+              "text": "CustomEvent",
+              "canonicalReference": "!CustomEvent:interface"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "StreamErrorEventDetail",
+              "canonicalReference": "@genesislcap/foundation-comms!StreamErrorEventDetail:type"
+            },
+            {
+              "kind": "Content",
+              "text": ">"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/connect/connect.events.ts",
+          "releaseTag": "Public",
+          "name": "StreamErrorEvent",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          }
+        },
+        {
+          "kind": "TypeAlias",
+          "canonicalReference": "@genesislcap/foundation-comms!StreamErrorEventDetail:type",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "export type StreamErrorEventDetail = "
+            },
+            {
+              "kind": "Reference",
+              "text": "Pick",
+              "canonicalReference": "!Pick:type"
+            },
+            {
+              "kind": "Content",
+              "text": "<"
+            },
+            {
+              "kind": "Reference",
+              "text": "StreamEventDetail",
+              "canonicalReference": "@genesislcap/foundation-comms!StreamEventDetail:type"
+            },
+            {
+              "kind": "Content",
+              "text": ", 'resourceName' | 'stream'> & {\n    error: any;\n}"
+            },
+            {
+              "kind": "Content",
+              "text": ";"
+            }
+          ],
+          "fileUrlPath": "src/connect/connect.events.ts",
+          "releaseTag": "Public",
+          "name": "StreamErrorEventDetail",
+          "typeTokenRange": {
+            "startIndex": 1,
+            "endIndex": 5
+          }
+        },
+        {
+          "kind": "Variable",
+          "canonicalReference": "@genesislcap/foundation-comms!StreamErrorEventType:var",
+          "docComment": "/**\n * @public\n */\n",
+          "excerptTokens": [
+            {
+              "kind": "Content",
+              "text": "StreamErrorEventType = "
+            },
+            {
+              "kind": "Content",
+              "text": "\"connect-stream-error-event\""
+            }
+          ],
+          "fileUrlPath": "src/connect/connect.events.ts",
+          "initializerTokenRange": {
+            "startIndex": 1,
+            "endIndex": 2
+          },
+          "isReadonly": true,
+          "releaseTag": "Public",
+          "name": "StreamErrorEventType",
+          "variableTypeTokenRange": {
+            "startIndex": 0,
+            "endIndex": 0
+          }
+        },
         {
           "kind": "TypeAlias",
           "canonicalReference": "@genesislcap/foundation-comms!StreamEvent:type",

package/dist/foundation-comms.d.ts

@@ -270,6 +270,7 @@ export declare interface Connect {
     streamState(resourceName: string, onMessage: Function, onError: Function, params?: any, initialState?: any[]): Observable<any[]>;
     /**
      * Starts listening for updates on the specified resource without auto-teardown.
+     * @deprecated - Use `stream` instead. Will be removed in v15.
      * @alpha
      * @param resourceName - The name of the resource to listen for updates on.
      * @param onMessage - A callback function to handle received messages.
@@ -379,8 +380,9 @@ export declare interface ConnectEvents {
      * Add a stream listener.
      * @param listener - A listener callback function.
      * @param complete - A complete listener callback function.
+     * @param error - A error listener callback function.
      */
-    addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>): () => void;
+    addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
     /**
      * Add a commit listener.
      * @param listener - A listener callback function.
@@ -417,6 +419,13 @@ export declare interface ConnectEventsEmitter extends ConnectEvents {
      * @param functions - Any functions provided.
      */
     onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
+    /**
+     * Called by Connect.
+     * @param resourceName - The name of the resource.
+     * @param stream - The actual stream itself.
+     * @param error - The error that occurred.
+     */
+    onStreamErrorEvent(resourceName: string, stream: SocketObservable<any>, error: any): void;
     /**
      * Called by Connect.
      * @param resourceName - The name of the resource.
@@ -1195,10 +1204,14 @@ export declare class DefaultConnectEvents implements ConnectEventsEmitter {
     protected streamListeners: Observer<StreamEvent>;
     /** @internal */
     protected streamCompleteListeners: Observer<StreamCompleteEvent>;
+    /** @internal */
+    protected streamErrorListeners: Observer<StreamErrorEvent>;
     /** {@inheritDoc ConnectEvents.addStreamListener} */
-    addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>): () => void;
+    addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
     /** {@inheritDoc ConnectEventsEmitter.onStreamEvent} */
     onStreamEvent(resourceName: string, message: Message<MessageDetails.DataserverRequest>, stream: SocketObservable<any>, functions: StreamEventFunctions): void;
+    /** {@inheritDoc ConnectEventsEmitter.onStreamErrorEvent} */
+    onStreamErrorEvent(resourceName: string, stream: SocketObservable<any>, error: any): void;
     /** {@inheritDoc ConnectEventsEmitter.onStreamCompleteEvent} */
     onStreamCompleteEvent(resourceName: string, stream: SocketObservable<any>): void;
     /** @internal */
@@ -2548,6 +2561,10 @@ export declare type Message<T = void | any> = {
 
 /**
  * A utility class for building different types of messages.
+ *
+ * @privateRemarks
+ * The SESSION_AUTH_TOKEN etc in messages should probably be removed with the move to cookies.
+ *
  * @public
  */
 export declare interface MessageBuilder {
@@ -2861,7 +2878,7 @@ export declare type MessageError = {
 /**
  * Check if the message contains an error code.
  * @param message - The message object.
- * @param code - The error code.
+ * @param code - The error code. Either a {@link http-status-codes#StatusCodes | StatusCodes} number or an entire status code string.
  * @public
  */
 export declare const messageHasErrorCode: (message: Message, code: string | number) => boolean;
@@ -3149,7 +3166,7 @@ export declare function normaliseCriteria(criteria: string, delimiter?: string):
 /**
  * @public
  */
-export declare type PingMessage = Pick<Message, 'MESSAGE_TYPE' | 'SOURCE_REF' | 'DETAILS'> & {
+export declare type PingMessage = Pick<Message, 'MESSAGE_TYPE' | 'SOURCE_REF' | 'DETAILS' | 'SESSION_AUTH_TOKEN'> & {
     VERBOSE?: boolean;
     [key: string]: any;
 };
@@ -3779,6 +3796,23 @@ export declare type StreamCompleteEventDetail = Pick<StreamEventDetail, 'resourc
  */
 export declare const StreamCompleteEventType = "connect-stream-complete-event";
 
+/**
+ * @public
+ */
+export declare type StreamErrorEvent = CustomEvent<StreamErrorEventDetail>;
+
+/**
+ * @public
+ */
+export declare type StreamErrorEventDetail = Pick<StreamEventDetail, 'resourceName' | 'stream'> & {
+    error: any;
+};
+
+/**
+ * @public
+ */
+export declare const StreamErrorEventType = "connect-stream-error-event";
+
 /**
  * @public
  */

package/docs/api/foundation-comms.connectevents.addstreamlistener.md

@@ -9,7 +9,7 @@ Add a stream listener.
 **Signature:**
 
 ```typescript
-addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>): () => void;
+addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
 ```
 
 ## Parameters
@@ -18,6 +18,7 @@ addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamComp
 |  --- | --- | --- |
 |  listener | Listener&lt;[StreamEvent](./foundation-comms.streamevent.md)<!-- -->&gt; | A listener callback function. |
 |  complete | Listener&lt;[StreamCompleteEvent](./foundation-comms.streamcompleteevent.md)<!-- -->&gt; | A complete listener callback function. |
+|  error | Listener&lt;[StreamErrorEvent](./foundation-comms.streamerrorevent.md)<!-- -->&gt; | A error listener callback function. |
 
 **Returns:**
 

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

@@ -18,5 +18,5 @@ export interface ConnectEvents
 |  --- | --- |
 |  [addCommitListener(listener)](./foundation-comms.connectevents.addcommitlistener.md) | Add a commit listener. |
 |  [addMetadataListener(listener)](./foundation-comms.connectevents.addmetadatalistener.md) | Add a metadata listener. |
-|  [addStreamListener(listener, complete)](./foundation-comms.connectevents.addstreamlistener.md) | Add a stream listener. |
+|  [addStreamListener(listener, complete, error)](./foundation-comms.connectevents.addstreamlistener.md) | Add a stream listener. |
 

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

@@ -20,5 +20,6 @@ export interface ConnectEventsEmitter extends ConnectEvents
 |  [onCommitEvent(eventName, message)](./foundation-comms.connecteventsemitter.oncommitevent.md) | Called by Connect. |
 |  [onMetadataEvent(resourceName, message, error)](./foundation-comms.connecteventsemitter.onmetadataevent.md) | Called by Connect. |
 |  [onStreamCompleteEvent(resourceName, stream)](./foundation-comms.connecteventsemitter.onstreamcompleteevent.md) | Called by Connect. |
+|  [onStreamErrorEvent(resourceName, stream, error)](./foundation-comms.connecteventsemitter.onstreamerrorevent.md) | Called by Connect. |
 |  [onStreamEvent(resourceName, message, stream, functions)](./foundation-comms.connecteventsemitter.onstreamevent.md) | Called by Connect. |
 

package/docs/api/foundation-comms.connecteventsemitter.onstreamerrorevent.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [ConnectEventsEmitter](./foundation-comms.connecteventsemitter.md) &gt; [onStreamErrorEvent](./foundation-comms.connecteventsemitter.onstreamerrorevent.md)
+
+## ConnectEventsEmitter.onStreamErrorEvent() method
+
+Called by Connect.
+
+**Signature:**
+
+```typescript
+onStreamErrorEvent(resourceName: string, stream: SocketObservable<any>, error: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  resourceName | string | The name of the resource. |
+|  stream | [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;any&gt; | The actual stream itself. |
+|  error | any | The error that occurred. |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-comms.defaultconnectevents.addstreamlistener.md

@@ -9,7 +9,7 @@ Add a stream listener.
 **Signature:**
 
 ```typescript
-addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>): () => void;
+addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamCompleteEvent>, error: Listener<StreamErrorEvent>): () => void;
 ```
 
 ## Parameters
@@ -18,6 +18,7 @@ addStreamListener(listener: Listener<StreamEvent>, complete: Listener<StreamComp
 |  --- | --- | --- |
 |  listener | Listener&lt;[StreamEvent](./foundation-comms.streamevent.md)<!-- -->&gt; | A listener callback function. |
 |  complete | Listener&lt;[StreamCompleteEvent](./foundation-comms.streamcompleteevent.md)<!-- -->&gt; | A complete listener callback function. |
+|  error | Listener&lt;[StreamErrorEvent](./foundation-comms.streamerrorevent.md)<!-- -->&gt; | A error listener callback function. |
 
 **Returns:**
 

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

@@ -19,9 +19,10 @@ export declare class DefaultConnectEvents implements ConnectEventsEmitter
 |  --- | --- | --- |
 |  [addCommitListener(listener)](./foundation-comms.defaultconnectevents.addcommitlistener.md) |  | Add a commit listener. |
 |  [addMetadataListener(listener)](./foundation-comms.defaultconnectevents.addmetadatalistener.md) |  | Add a metadata listener. |
-|  [addStreamListener(listener, complete)](./foundation-comms.defaultconnectevents.addstreamlistener.md) |  | Add a stream listener. |
+|  [addStreamListener(listener, complete, error)](./foundation-comms.defaultconnectevents.addstreamlistener.md) |  | Add a stream listener. |
 |  [onCommitEvent(eventName, message)](./foundation-comms.defaultconnectevents.oncommitevent.md) |  | Called by Connect. |
 |  [onMetadataEvent(resourceName, message, error)](./foundation-comms.defaultconnectevents.onmetadataevent.md) |  | Called by Connect. |
 |  [onStreamCompleteEvent(resourceName, stream)](./foundation-comms.defaultconnectevents.onstreamcompleteevent.md) |  | Called by Connect. |
+|  [onStreamErrorEvent(resourceName, stream, error)](./foundation-comms.defaultconnectevents.onstreamerrorevent.md) |  | Called by Connect. |
 |  [onStreamEvent(resourceName, message, stream, functions)](./foundation-comms.defaultconnectevents.onstreamevent.md) |  | Called by Connect. |
 

package/docs/api/foundation-comms.defaultconnectevents.onstreamerrorevent.md

@@ -0,0 +1,26 @@
+<!-- Do not edit this file. It is automatically generated by API Documenter. -->
+
+[Home](./index.md) &gt; [@genesislcap/foundation-comms](./foundation-comms.md) &gt; [DefaultConnectEvents](./foundation-comms.defaultconnectevents.md) &gt; [onStreamErrorEvent](./foundation-comms.defaultconnectevents.onstreamerrorevent.md)
+
+## DefaultConnectEvents.onStreamErrorEvent() method
+
+Called by Connect.
+
+**Signature:**
+
+```typescript
+onStreamErrorEvent(resourceName: string, stream: SocketObservable<any>, error: any): void;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  resourceName | string | The name of the resource. |
+|  stream | [SocketObservable](./foundation-comms.socketobservable.md)<!-- -->&lt;any&gt; | The actual stream itself. |
+|  error | any | The error that occurred. |
+
+**Returns:**
+
+void
+

package/docs/api/foundation-comms.md

@@ -122,6 +122,7 @@
 |  [networkLogger](./foundation-comms.networklogger.md) |  |
 |  [retryInterval](./foundation-comms.retryinterval.md) | Generate reconnect interval based on scheduler |
 |  [StreamCompleteEventType](./foundation-comms.streamcompleteeventtype.md) |  |
+|  [StreamErrorEventType](./foundation-comms.streamerroreventtype.md) |  |
 |  [StreamEventType](./foundation-comms.streameventtype.md) |  |
 |  [SystemHealthChanged](./foundation-comms.systemhealthchanged.md) | SystemHealthChanged. |
 |  [toFieldMetadata](./foundation-comms.tofieldmetadata.md) | Converts the field definitions to field metadata. |
@@ -175,6 +176,8 @@
 |  [StorageType](./foundation-comms.storagetype.md) | The available browser storage types. |
 |  [StreamCompleteEvent](./foundation-comms.streamcompleteevent.md) |  |
 |  [StreamCompleteEventDetail](./foundation-comms.streamcompleteeventdetail.md) |  |
+|  [StreamErrorEvent](./foundation-comms.streamerrorevent.md) |  |
+|  [StreamErrorEventDetail](./foundation-comms.streamerroreventdetail.md) |  |
 |  [StreamEvent](./foundation-comms.streamevent.md) |  |
 |  [StreamEventDetail](./foundation-comms.streameventdetail.md) |  |
 |  [StreamEventFunctions](./foundation-comms.streameventfunctions.md) |  |