Fix page object demo examples in API docs. (nightwatchjs#4210)

dikwickley · Oct 15, 2024 · 7f68a85 · 7f68a85
1 parent ee95819
commit 7f68a85
Show file tree

Hide file tree

Showing 5 changed files with 13 additions and 13 deletions.
diff --git a/lib/api/element-commands/waitForElementNotPresent.js b/lib/api/element-commands/waitForElementNotPresent.js
@@ -62,7 +62,7 @@ const WaitForElement = require('./_waitFor.js');
  *        .navigate()
  *        .assert.titleContains('Nightwatch.js');
  *
- *      nightwatch.api.waitForElementNotPresent('@dialogContainer', function(result) {
+ *      nightwatch..waitForElementNotPresent('@dialogContainer', function(result) {
  *        console.log(result);
  *      });
  *   }
@@ -99,14 +99,14 @@ class WaitForElementNotPresent extends WaitForElement {
    * @returns {Promise}
    */
   elementFound(result) {
-    let defaultMsg = 'Timed out while waiting for element <%s> to be removed for %d milliseconds.';
+    const defaultMsg = 'Timed out while waiting for element <%s> to be removed for %d milliseconds.';
     result.passed = false;
 
     return this.fail(result, 'found', this.expectedValue, defaultMsg);
   }
 
   elementNotFound(result) {
-    let defaultMsg = 'Element <%s> was not present after %d milliseconds.';
+    const defaultMsg = 'Element <%s> was not present after %d milliseconds.';
     result.passed = true;
 
     return this.pass(result, defaultMsg, this.executor.elapsedTime);

diff --git a/lib/api/element-commands/waitForElementNotVisible.js b/lib/api/element-commands/waitForElementNotVisible.js
@@ -62,7 +62,7 @@ const WaitForDisplayed = require('./_waitForDisplayed.js');
  *        .navigate()
  *        .assert.titleContains('Nightwatch.js');
  *
- *      nightwatch.api.waitForElementNotVisible('@mainDialog', function(result) {
+ *      nightwatch.waitForElementNotVisible('@mainDialog', function(result) {
  *        console.log(result);
  *      });
  *   }
@@ -93,13 +93,13 @@ class WaitForElementNotVisible extends WaitForDisplayed {
   }
 
   elementVisible(response) {
-    let defaultMsg = 'Timed out while waiting for element <%s> to not be visible for %d milliseconds.';
+    const defaultMsg = 'Timed out while waiting for element <%s> to not be visible for %d milliseconds.';
 
     return this.fail(response, 'visible', this.expectedValue, defaultMsg);
   }
 
   elementNotVisible(response) {
-    let defaultMsg = 'Element <%s> was not visible after %d milliseconds.';
+    const defaultMsg = 'Element <%s> was not visible after %d milliseconds.';
 
     return this.pass(response, defaultMsg, this.executor.elapsedTime);
   }

diff --git a/lib/api/element-commands/waitForElementPresent.js b/lib/api/element-commands/waitForElementPresent.js
@@ -62,7 +62,7 @@ const WaitForElement = require('./_waitFor.js');
  *        .navigate()
  *        .assert.titleContains('Nightwatch.js');
  *
- *      nightwatch.api.waitForElementPresent('@featuresList', function(result) {
+ *      nightwatch.waitForElementPresent('@featuresList', function(result) {
  *        console.log(result);
  *      });
  *   }

diff --git a/lib/api/element-commands/waitForElementVisible.js b/lib/api/element-commands/waitForElementVisible.js
@@ -64,7 +64,7 @@ const WaitForDisplayed = require('./_waitForDisplayed.js');
  *        .navigate()
  *        .assert.titleContains('Nightwatch.js');
  *
- *      nightwatch.api.waitForElementVisible('@featuresList', function(result) {
+ *      nightwatch.waitForElementVisible('@featuresList', function(result) {
  *        console.log(result);
  *      });
  *   }
@@ -94,13 +94,13 @@ class WaitForElementVisible extends WaitForDisplayed {
   }
 
   elementVisible(response) {
-    let defaultMsg = 'Element <%s> was visible after %d milliseconds.';
+    const defaultMsg = 'Element <%s> was visible after %d milliseconds.';
 
     return this.pass(response, defaultMsg, this.executor.elapsedTime);
   }
 
   elementNotVisible(response) {
-    let defaultMsg = 'Timed out while waiting for element <%s> to be visible for %d milliseconds.';
+    const defaultMsg = 'Timed out while waiting for element <%s> to be visible for %d milliseconds.';
 
     return this.fail(response, 'not visible', this.expectedValue, defaultMsg);
   }

diff --git a/types/index.d.ts b/types/index.d.ts
@@ -3403,7 +3403,7 @@ export interface ElementCommands {
    *        .navigate()
    *        .assert.titleContains('Nightwatch.js');
    *
-   *      nightwatch.api.waitForElementNotPresent('@dialogContainer', function(result) {
+   *      nightwatch.waitForElementNotPresent('@dialogContainer', function(result) {
    *        console.log(result);
    *      });
    *   }
@@ -3498,7 +3498,7 @@ export interface ElementCommands {
    *        .navigate()
    *        .assert.titleContains('Nightwatch.js');
    *
-   *      nightwatch.api.waitForElementNotVisible('@mainDialog', function(result) {
+   *      nightwatch.waitForElementNotVisible('@mainDialog', function(result) {
    *        console.log(result);
    *      });
    *   }
@@ -3591,7 +3591,7 @@ export interface ElementCommands {
    *        .navigate()
    *        .assert.titleContains('Nightwatch.js');
    *
-   *      nightwatch.api.waitForElementPresent('@featuresList', function(result) {
+   *      nightwatch.waitForElementPresent('@featuresList', function(result) {
    *        console.log(result);
    *      });
    *   }