Fix/refactor types migrated from DefinitelyTyped (#3744)

nightwatchjs · May 31, 2023 · 7b9c5bf · 7b9c5bf
1 parent 543115b
commit 7b9c5bf
Show file tree

Hide file tree

Showing 9 changed files with 276 additions and 110 deletions.
diff --git a/lib/api/element-commands/getLocationInView.js b/lib/api/element-commands/getLocationInView.js
@@ -23,6 +23,7 @@ const BaseElementCommand = require('./_baseElementCommand.js');
  * @returns {{x: number, y: number}} The X and Y coordinates for the element on the page.
  * @jsonwire
  * @api protocol.elementlocation
+ * @deprecated This is a JSON Wire Protocol command and is no longer supported.
  */
 class GetLocationInView extends BaseElementCommand {
   get w3c_deprecated() {

diff --git a/lib/api/protocol/elementIdLocationInView.js b/lib/api/protocol/elementIdLocationInView.js
@@ -4,9 +4,10 @@ const ProtocolAction = require('./_base-action.js');
  * Determine an element's location on the screen once it has been scrolled into view.
  *
  * @link
-  * @param {string} webElementId The [Web Element ID](https://www.w3.org/TR/webdriver1/#dfn-web-elements) of the element to route the command to.
+ * @param {string} webElementId The [Web Element ID](https://www.w3.org/TR/webdriver1/#dfn-web-elements) of the element to route the command to.
  * @param {function} [callback] Optional callback function to be called when the command finishes.
  * @api protocol.elementinternal
+ * @deprecated This is a JSON Wire Protocol command and is no longer supported.
  */
 module.exports = class Session extends ProtocolAction {
   get w3c_deprecated() {

diff --git a/types/assertions.d.ts b/types/assertions.d.ts
@@ -14,7 +14,7 @@ export interface NightwatchCommonAssertions<ReturnType> {
 	 * Checks if the given attribute of an element contains the expected value.
 	 *
 	 * ```
-	 *    this.demoTest = function (client) {
+	 *    this.demoTest = function (browser) {
 	 *      browser.assert.attributeContains('#someElement', 'href', 'google.com');
 	 *    };
 	 * ```
@@ -30,7 +30,7 @@ export interface NightwatchCommonAssertions<ReturnType> {
 	 * Checks if the given attribute of an element has the expected value.
 	 *
 	 * ```
-	 *    this.demoTest = function (client) {
+	 *    this.demoTest = function (browser) {
 	 *      browser.assert.attributeEquals('body', 'data-attr', 'some value');
 	 *    };
 	 * ```
@@ -65,7 +65,7 @@ export interface NightwatchCommonAssertions<ReturnType> {
 	 * Checks if the specified css property of a given element has the expected value.
 	 *
 	 * ```
-	 *    this.demoTest = function (client) {
+	 *    this.demoTest = function (browser) {
 	 *      browser.assert.cssProperty('#main', 'display', 'block');
 	 *    };
 	 * ```
@@ -138,7 +138,7 @@ export interface NightwatchCommonAssertions<ReturnType> {
 	 * Checks if the given element exists in the DOM.
 	 *
 	 * ```
-	 *    this.demoTest = function (client) {
+	 *    this.demoTest = function (browser) {
 	 *      browser.assert.elementPresent("#main");
 	 *    };
 	 * ```
@@ -192,7 +192,7 @@ export interface NightwatchCommonAssertions<ReturnType> {
 	 * Checks if the given element has the specified CSS class.
 	 *
 	 * ```
-	 *    this.demoTest = function (client) {
+	 *    this.demoTest = function (browser) {
 	 *      browser.assert.cssClassPresent('#main', 'container');
 	 *    };
 	 * ```
@@ -280,7 +280,7 @@ export interface NightwatchCommonAssertions<ReturnType> {
 	 * Checks if the given element contains the specified text.
 	 *
 	 * ```
-	 *    this.demoTest = function (client) {
+	 *    this.demoTest = function (browser) {
 	 *      browser.assert.containsText('#main', 'The Night Watch');
 	 *    };
 	 * ```
@@ -350,7 +350,7 @@ export interface NightwatchCommonAssertions<ReturnType> {
 	 * Checks if the page title equals the given value.
 	 *
 	 * ```
-	 *    this.demoTest = function (client) {
+	 *    this.demoTest = function (browser) {
 	 *      browser.assert.title("Nightwatch.js");
 	 *    };
 	 * ```
@@ -366,7 +366,7 @@ export interface NightwatchCommonAssertions<ReturnType> {
 	 * Checks if the page title equals the given value.
 	 *
 	 * ```
-	 *    this.demoTest = function (client) {
+	 *    this.demoTest = function (browser) {
 	 *      browser.assert.title("Nightwatch.js");
 	 *    };
 	 * ```
@@ -380,7 +380,7 @@ export interface NightwatchCommonAssertions<ReturnType> {
 	 * Checks if the page title equals the given value.
 	 * @since 2.0
 	 * ```
-	 *    this.demoTest = function (client) {
+	 *    this.demoTest = function (browser) {
 	 *      browser.assert.titleEquals("Nightwatch.js");
 	 *    };
 	 * ```
@@ -396,7 +396,7 @@ export interface NightwatchCommonAssertions<ReturnType> {
 	 * @example
 	 *
 	 * ```
-	 *    this.demoTest = function (client) {
+	 *    this.demoTest = function (browser) {
 	 *      browser.assert.titleMatches('^Nightwatch');
 	 *    };
 	 * ```
@@ -411,7 +411,7 @@ export interface NightwatchCommonAssertions<ReturnType> {
 	 * Checks if the current URL contains the given value.
 	 *
 	 * ```
-	 *    this.demoTest = function (client) {
+	 *    this.demoTest = function (browser) {
 	 *      browser.assert.urlContains('google');
 	 *    };
 	 * ```
@@ -425,7 +425,7 @@ export interface NightwatchCommonAssertions<ReturnType> {
 	 * Checks if the current url equals the given value.
 	 *
 	 * ```
-	 *    this.demoTest = function (client) {
+	 *    this.demoTest = function (browser) {
 	 *      browser.assert.urlEquals('https://www.google.com');
 	 *    };
 	 * ```
@@ -440,7 +440,7 @@ export interface NightwatchCommonAssertions<ReturnType> {
 	 *
 	 * @example
 	 * ```
-	 *    this.demoTest = function (client) {
+	 *    this.demoTest = function (browser) {
 	 *      browser.assert.urlMatches('^https');
 	 *    };
 	 * ```
@@ -455,7 +455,7 @@ export interface NightwatchCommonAssertions<ReturnType> {
 	 * Checks if the given form element's value equals the expected value.
 	 *
 	 * ```
-	 *    this.demoTest = function (client) {
+	 *    this.demoTest = function (browser) {
 	 *      browser.assert.value("form.login input[type=text]", "username");
 	 *    };
 	 * ```
@@ -472,7 +472,7 @@ export interface NightwatchCommonAssertions<ReturnType> {
 	 * Checks if the given form element's value contains the expected value.
 	 *
 	 * ```
-	 *    this.demoTest = function (client) {
+	 *    this.demoTest = function (browser) {
 	 *      browser.assert.valueContains("form.login input[type=text]", "username");
 	 *    };
 	 * ```
@@ -523,7 +523,7 @@ export interface NightwatchCommonAssertions<ReturnType> {
 	 * Checks if the given element is visible on the page.
 	 *
 	 * ```
-	 *    this.demoTest = function (client) {
+	 *    this.demoTest = function (browser) {
 	 *      browser.assert.visible(".should_be_visible");
 	 *    };
 	 * ```