Update jsdoc string for CloudSynchroniser (#48)

* Update jsdoc string for CloudSynchroniser to describe expected hostname, port object * Update other mentions of syncUrl
bbc · Apr 19, 2022 · 57e1c94 · 57e1c94
1 parent 739adc3
commit 57e1c94
Show file tree

Hide file tree

Showing 4 changed files with 9 additions and 5 deletions.
diff --git a/packages/cloud-sync-client/client-api.md b/packages/cloud-sync-client/client-api.md
@@ -108,7 +108,7 @@ The ```options``` parameter is an object specifying preferences such as the sync
 // Require cloud-synchroniser module
 var cloudSyncKit = require("CloudSyncKit");
 
-var syncUrl = "mqttbroker.edge.platform.2immerse.eu"; // a Sync Service MQTT endpoint
+var syncUrl = { hostname: "mqttbroker.edge.platform.2immerse.eu" }; // a Sync Service MQTT endpoint
 var sessionId = "223dsf452asd"; // a globally-unique session identifier
 var deviceId = "chris_iphone"; // a client identifier 
 var options = { syncTimelineElection: cloudSyncKit.SyncTLElection.DYNAMIC }; // options e.g. desired sync mode

diff --git a/packages/cloud-sync-client/src/client/CloudSyncKit.js b/packages/cloud-sync-client/src/client/CloudSyncKit.js
@@ -13,7 +13,9 @@ module.exports = {
     /**
      * 
      * Returns an instance of CloudSynchroniser
-     * @param {string} syncUrl
+     * @param {object} syncUrl An object specifying connection parameters
+     * @param {string} syncUrl.hostname
+     * @param {number=} syncUrl.port
      * @param {string} sessionId
      * @param {string} contextId
      * @param {string} deviceId

diff --git a/packages/cloud-sync-client/src/client/CloudSynchroniser.js b/packages/cloud-sync-client/src/client/CloudSynchroniser.js
@@ -164,7 +164,9 @@ function log() {
  * @classdesc Client library of the cloud Synchronisation Service.
  * 
  * @constructor
- * @param {string} syncUrl Address of the Synchronisation Service
+ * @param {object} syncUrl An object specifying connection parameters
+ * @param {string} syncUrl.hostname
+ * @param {number=} syncUrl.port Optional port number for a plain ws:// connection, if not given the default HTTPS port and wss:// protocol is used
  * @param {string} sessionId Identifier of the synchronisation session
  * @param {string} contextId Identifier of the synchronisation context
  * @param {string} deviceId Identifier of for this client, i.e. device

diff --git a/packages/cloud-sync-client/src/client/readme.md b/packages/cloud-sync-client/src/client/readme.md
@@ -108,7 +108,7 @@ The ```options``` parameter is an object specifying preferences such as the sync
 // Require cloud-synchroniser module
 var cloudSyncKit = require("CloudSyncKit");
 
-var syncUrl = "mqttbroker.edge.platform.2immerse.eu"; // a Sync Service MQTT endpoint
+var syncUrl = { hostname: "mqttbroker.edge.platform.2immerse.eu" }; // a Sync Service MQTT endpoint
 var sessionId = "223dsf452asd"; // a globally-unique session identifier
 var deviceId = "chris_iphone"; // a client identifier 
 var options = { syncTimelineElection: cloudSyncKit.SyncTLElection.DYNAMIC }; // options e.g. desired sync mode
@@ -288,4 +288,4 @@ Documentation is generated and output as HTML into the `doc` subfolder.
 ## Authors
 
  * Rajiv Ramdhany (BBC)
- * Christoph Ziegler (IRT)
+ * Christoph Ziegler (IRT)