Add .text() as alias for .getText() (#4180)

nightwatchjs · Apr 17, 2024 · e159472 · e159472
1 parent b7275e9
commit e159472
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 0 deletions.
diff --git a/lib/api/web-element/scoped-element.js b/lib/api/web-element/scoped-element.js
@@ -23,6 +23,7 @@ class ScopedWebElement {
       'findAllByPlaceholderText': ['getAllByPlaceholderText'],
       'findAllByAltText': ['getAllByAltText'],
       'getRect': ['getSize', 'getLocation', 'rect'],
+      'getText': ['text'],
       'getProperty': ['property'],
       'getCssProperty': ['css'],
       'getAriaRole': ['ariaRole'],

diff --git a/test/src/api/commands/web-element/testGetText.js b/test/src/api/commands/web-element/testGetText.js
@@ -38,6 +38,30 @@ describe('element().getText() command', function () {
     assert.strictEqual(resultValue, 'Signup');
   });
 
+  it('test .element().text() alias', async function() {
+    MockServer.addMock({
+      url: '/session/13521-10219-202/element/0/text',
+      method: 'GET',
+      response: JSON.stringify({
+        value: 'Signup'
+      })
+    }, true);
+
+    const resultPromise = this.client.api.element('#signupSection').text();
+    assert.strictEqual(resultPromise instanceof Element, false);
+    assert.strictEqual(typeof resultPromise.find, 'undefined');
+
+    assert.strictEqual(resultPromise instanceof Promise, false);
+    assert.strictEqual(typeof resultPromise.then, 'function');
+
+    const result = await resultPromise;
+    assert.strictEqual(result instanceof WebElement, false);
+    assert.strictEqual(result, 'Signup');
+
+    const resultValue = await resultPromise.value;
+    assert.strictEqual(resultValue, 'Signup');
+  });
+
   it('test .element().find().getText()', async function() {
     MockServer.addMock({
       url: '/session/13521-10219-202/element/1/text',
@@ -110,4 +134,5 @@ describe('element().getText() command', function () {
     assert.strictEqual(await resultPromise.assert.not.contains('Signupx'), 'Signup');
     assert.strictEqual(await resultPromise.assert.not.matches(/Si[a-z]{2}upx/), 'Signup');
   });
+
 });
diff --git a/types/tests/webElement.test-d.ts b/types/tests/webElement.test-d.ts
@@ -136,6 +136,7 @@ describe('new element() api', function () {
     expectType<ElementValue<string>>(elem.getId());
     expectType<ElementValue<string>>(elem.getTagName());
     expectType<ElementValue<string>>(elem.getText());
+    expectType<ElementValue<string>>(elem.text());
 
     expectType<ElementValue<string | null>>(elem.getProperty('property-name'));
     expectType<ElementValue<string | null>>(elem.getAttribute('attrib-name'));

diff --git a/types/web-element.d.ts b/types/web-element.d.ts
@@ -148,6 +148,7 @@ export interface ScopedElement extends Element, PromiseLike<WebElement> {
   getTagName(): ElementValue<string>;
 
   getText(): ElementValue<string>;
+  text(): ElementValue<string>;
 
   click(): Promise<WebElement>;