(docs): saveScreenshot requires afterTest hook to be async

hashar · hashar · commit f7cabb69a5de · 2023-08-25T14:09:04.000+02:00
When requesting a screenshot in the `afterTest` hook, I would sometime not have any screenshot generated. I eventually found `browser.saveScreenshot` is an async function and the hook has to be explicitly defined `async`: #5545 (comment) Add an example to the `browser.saveScreenshot` documentation showing how to use it in the `afterTest` hook. Signed-off-by: Antoine Musso <amusso@wikimedia.org>
diff --git a/packages/webdriverio/src/commands/browser/saveScreenshot.ts b/packages/webdriverio/src/commands/browser/saveScreenshot.ts
@@ -14,6 +14,13 @@ import { getAbsoluteFilepath, assertDirectoryExists } from '../../utils/index.js
     });
  * </example>
  *
+ * When running from a hook, make sure to explicitly define the hook as async:
+ * <example>
+  :wdio.conf.js
+  afterTest: async function(test) {
+      await browser.saveScreenshot('./some/path/screenshot.png');
+  }
+ * </example>
  * @alias browser.saveScreenshot
  * @param   {String}  filepath  path to the generated image (`.png` suffix is required) relative to the execution directory
  * @return  {Buffer}            screenshot buffer
