Add documentation notes for connectedDevices.

dotintent · Mar 21, 2018 · 4f4c755 · 4f4c755
1 parent 747863d
commit 4f4c755
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/docs/index.html b/docs/index.html
@@ -2564,7 +2564,8 @@ <h3 class='fl m0' id='blemanager'>
 
 
 
-  <p>Returns a list of the peripherals (containing any of the specified services) currently connected to the system.</p>
+  <p>Returns a list of the peripherals (containing any of the specified services) currently connected to the system.
+Make sure that services are actually discovered for specified device before calling this function.</p>
 
 
   <div class='pre p1 fill-light mt0'>connectedDevices(serviceUUIDs: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&#x3C;<a href="#uuid">UUID</a>>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise">Promise</a>&#x3C;<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Array">Array</a>&#x3C;<a href="#device">Device</a>>></div>

diff --git a/src/BleManager.js b/src/BleManager.js
@@ -359,6 +359,7 @@ export class BleManager {
 
   /**
    * Returns a list of the peripherals (containing any of the specified services) currently connected to the system.
+   * Make sure that services are actually discovered for specified device before calling this function.
    * @param {Array<UUID>} serviceUUIDs List of service UUIDs. Device must contain as list one of them to be listed.
    */
   async connectedDevices(serviceUUIDs: Array<UUID>): Promise<Array<Device>> {