Merge pull request #100 from kuzzleio/KZL-788-subscribe-shall-return-…

…the-roomId

realtime: updated subscribe documentation according to BUG KZL-788

src/sdk-reference/js/6/realtime/count/snippets/count.js

@@ -1,7 +1,7 @@
 function callback (notification) {}
 
 try {
-  const { roomId } = await kuzzle.realtime.subscribe('nyc-open-data', 'yellow-taxi', {}, callback);
+  const roomId = await kuzzle.realtime.subscribe('nyc-open-data', 'yellow-taxi', {}, callback);
 
   const count = await kuzzle.realtime.count(roomId);
 

src/sdk-reference/js/6/realtime/subscribe/index.md

@@ -19,7 +19,7 @@ Subscribes by providing a set of filters: messages, document changes and, option
 * @param {object} filters
 * @param {Function} callback
 * @param {object} [options]
-* @returns {Promise.<object>}
+* @returns {Promise<string>}
  */
  subscribe (index, collection, filters, callback, options = null)
 ```
@@ -52,13 +52,7 @@ Additional subscription options.
 
 ## Resolve
 
-Resolve to an object containing the following properties:
-
-| Property   | Type    | Description                       |
-| ---------- | ------- | --------------------------------- |
-| `roomId` | String | The room ID |
-| `channel` | String | The channel ID |
-
+Resolves to a string containing the room ID
 
 ## Usage
 

src/sdk-reference/js/6/realtime/subscribe/snippets/user-notifications.js

@@ -28,7 +28,7 @@ try {
   // Subscribe users notifications
   const options = { users: 'all' };
 
-  const { roomId } = await kuzzle.realtime.subscribe('nyc-open-data', 'yellow-taxi', filters, callback, options);
+  const roomId = await kuzzle.realtime.subscribe('nyc-open-data', 'yellow-taxi', filters, callback, options);
 
   // Subscribe to the same room with the second client
   const opfions = { users: 'all', volatile: { username: 'nina vkote' } };

src/sdk-reference/js/6/realtime/unsubscribe/snippets/unsubscribe.js

@@ -1,7 +1,7 @@
 function callback (notification) {}
 
 try {
-  const { roomId } = await kuzzle.realtime.subscribe('nyc-open-data', 'yellow-taxi', {}, callback);
+  const roomId = await kuzzle.realtime.subscribe('nyc-open-data', 'yellow-taxi', {}, callback);
 
   await kuzzle.realtime.unsubscribe(roomId);