Update config and options for eds sdk

Macrometacorp · Sep 24, 2024 · c2b2b39 · c2b2b39
1 parent f53ca18
commit c2b2b39
Show file tree

Hide file tree

Showing 3 changed files with 27 additions and 10 deletions.
diff --git a/docs/photoniq/event-delivery/clients/index.md b/docs/photoniq/event-delivery/clients/index.md
@@ -115,11 +115,20 @@ let connection = PhotoniqEdsSdk.create(config);
 
 | **Property** | **Type** | **Requred** | **Description** |
 |----------------------|-----------|-----------|-----------------------------------|
-| `host` | `string` | Yes | Host of the connectionn   |
+| `host` | `string` | Yes | Host of the connection   |
 | `customerId` | `string` | Yes | Customer ID credentails    |
 | `apiKey` | `string` | Yes | ApiKey credentails    |
 | `fabric` | `string` | No | Fabric to be used. Default is `_system`   |
-| `connectionTypes` | `string[]` | No | Use type of connection and priority. Default is `["ws"]`. Types: `ws`, `sse`    |
-| `queryType` | `string` | No | Type of query to use. Types: `"SQL"`   |
+| `connectionTypes` | `(string `\|` SubConfig)[]` | No | Use type of connection and priority. Default is `["ws"]`. Types: `ws`, `sse`    |
 | `autoReconnect` | `boolean` | No | Automatically reconnect in case of network issues. Default is `true`    |
-| `pingSeconds` | `number` | No | Seconds between ping-pong messages to the WebSocket server. Default is `29`   |
+
+#### `SubConfig` instance schema:
+
+| **Property** | **Type** | **Requred** | **Description** |
+|----------------------|-----------|-----------|-----------------------------------|
+| `type` | `string` | Yes | Type of the connection. Value: `ws` or `sse`   |
+| `customerId` | `string` | No | Customer ID credentails. Default set from `Config`     |
+| `apiKey` | `string` | No | ApiKey credentails. Default set from `Config`   |
+| `fabric` | `string` | No | Fabric to be used. Default set from `Config`  |
+| `pingSeconds` | `number` | No | Seconds between ping-pong messages to the WebSocket server. Default is `29`. Acceptable only for `ws` connection.   |
+| `flushTimeoutMs` | `number` | No | Seconds between ping-pong messages to the WebSocket server. Default is `20`. Acceptable only for `sse` connection.   |
diff --git a/docs/photoniq/event-delivery/clients/query-set-and-batch.md b/docs/photoniq/event-delivery/clients/query-set-and-batch.md
@@ -25,8 +25,8 @@ querySet.retrieve("SELECT * FROM <YOUR-COLLECTION> WHERE key=<YOUR-KEY>", (event
 |--------------|------------|----------|------------------------|
 | `query` | `string` | Yes | SQL query to retrieve/listen  |
 | `resultListener`| `function` | Yes |  [Info](/photoniq/event-delivery/clients/listeners-and-errors#result-listener) |
-| `errorListener`| `function` | No |  [Info](/photoniq/event-delivery/clients/listeners-and-errors#error-listener) |
-| `compress` | `boolean` | No | Compress incoming initial data.  |
+| `errorListenerOrOptions`| `function `\|` QueryOptions` | No |  [Info](/photoniq/event-delivery/clients/listeners-and-errors#error-listener) or set query options |
+| `options` | `QueryOptions` | No | Set query options.  |
 
 ### retrieveAndSubscribe
 
@@ -41,8 +41,8 @@ querySet.retrieveAndSubscribe("SELECT * FROM <YOUR-COLLECTION> WHERE key=<YOUR-K
 |--------------|------------|----------|-------------------|
 | `query` | `string` | Yes | SQL query to retrieve/listen  |
 | `resultListener`| `function` | Yes |  [Info](/photoniq/event-delivery/clients/listeners-and-errors#result-listener) |
-| `errorListener`| `function` | No |  [Info](/photoniq/event-delivery/clients/listeners-and-errors#error-listener) |
-| `compress` | `boolean` | No | Compress incoming initial data.  |
+| `errorListenerOrOptions`| `function `\|` QueryOptions` | No |  [Info](/photoniq/event-delivery/clients/listeners-and-errors#error-listener) or set query options |
+| `options` | `QueryOptions` | No | Set query options.  |
 
 ### subscribe
 
@@ -57,7 +57,8 @@ querySet.subscribe("SELECT * FROM <YOUR-COLLECTION> WHERE key=<YOUR-KEY>", (even
 |--------------|------------|----------|-------------------|
 | `query` | `string` | Yes | SQL query to retrieve/listen  |
 | `resultListener`| `function` | Yes |  [Info](/photoniq/event-delivery/clients/listeners-and-errors#result-listener) |
-| `errorListener`| `function` | No |  [Info](/photoniq/event-delivery/clients/listeners-and-errors#error-listener) |
+| `errorListenerOrOptions`| `function `\|` QueryOptions` | No |  [Info](/photoniq/event-delivery/clients/listeners-and-errors#error-listener) or set query options |
+| `options` | `QueryOptions` | No | Set query options.  |
 
 ### unubscribe
 
@@ -92,3 +93,10 @@ Removes all subscriptions in the `QuerySet`:
 ```js
 querySet.unsubscribeAll();
 ```
+
+
+#### `QueryOptions` instance schema:
+
+| **Property** | **Type** | **Requred** | **Description** |
+|--------------|----------|-------------|-----------------|
+| `compress` | `bolean` | No | compress response data  |