docs: add example of navigation back/forward

sitespeedio · Apr 12, 2024 · 1dad30d · 1dad30d
1 parent 315dde3
commit 1dad30d
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/lib/core/engine/command/navigation.js b/lib/core/engine/command/navigation.js
@@ -24,6 +24,7 @@ export class Navigation {
    * Navigates backward in the browser's history.
    *
    * @async
+   * @example await commands.navigation.back();
    * @param {Object} [options] - Additional options for navigation. Set {wait:true} to wait for the page complete check to run.
    * @returns {Promise<void>} A promise that resolves when the navigation action is completed.
    * @throws {Error} Throws an error if navigation fails.
@@ -46,6 +47,7 @@ export class Navigation {
    * Navigates forward in the browser's history.
    *
    * @async
+   * @example await commands.navigation.forward();
    * @param {Object} [options] - Additional options for navigation. Set {wait:true} to wait for the page complete check to run.
    * @returns {Promise<void>} A promise that resolves when the navigation action is completed.
    * @throws {Error} Throws an error if navigation fails.
@@ -68,6 +70,7 @@ export class Navigation {
    * Refreshes the current page.
    *
    * @async
+   * @example await commands.navigation.refresh();
    * @param {Object} [options] - Additional options for refresh action. Set {wait:true} to wait for the page complete check to run.
    * @returns {Promise<void>} A promise that resolves when the page has been refreshed.
    * @throws {Error} Throws an error if refreshing the page fails.