Merge pull request #169 from mido3ds/patch-1

Update api.md
schickling · Nov 3, 2017 · b3a111f · b3a111f
2 parents e34b387 + 3ddfd93
commit b3a111f
Showing 1 changed file with 7 additions and 2 deletions.
diff --git a/docs/api.md b/docs/api.md
@@ -163,7 +163,7 @@ await chromeless.wait('div#loaded', 1000)
 
 Not implemented yet
 
-Wait until a function returns.
+Wait until a function returns. You can also return some Promise that will be resolved at some point.
 
 __Arguments__
 - `fn` - Function to wait for
@@ -172,7 +172,12 @@ __Arguments__
 __Example__
 
 ```js
-await chromeless.wait(() => { return console.log('@TODO: put a better example here') })
+await chromeless.wait(() => { 
+  return new Promise((resolve, reject) => {
+    // do something async, setTimeout...
+    resolve();
+  });
+})
 ```
 
 ---------------------------------------