Add .tagname() as alias for .getTagName(). (#4176)

Co-authored-by: Priyansh Garg <priyanshgarg30@gmail.com>
nightwatchjs · Apr 18, 2024 · 526fa26 · 526fa26
1 parent 88ba6c6
commit 526fa26
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
@@ -25,6 +25,7 @@ class ScopedWebElement {
       'getRect': ['getSize', 'getLocation', 'rect'],
       'getProperty': ['property', 'prop'],
       'getText': ['text'],
+      'getTagName': ['tagName'],
       'getAccessibleName': ['accessibleName'],
       'getCssProperty': ['css'],
       'getAriaRole': ['ariaRole'],

diff --git a/test/src/api/commands/web-element/testGetTagName.js b/test/src/api/commands/web-element/testGetTagName.js
@@ -38,6 +38,30 @@ describe('element().getTagName() command', function () {
     assert.strictEqual(resultValue, 'div');
   });
 
+  it('test .element().tagName() alias', async function() {
+    MockServer.addMock({
+      url: '/session/13521-10219-202/element/0/name',
+      method: 'GET',
+      response: JSON.stringify({
+        value: 'div'
+      })
+    }, true);
+
+    const resultPromise = this.client.api.element('#signupSection').tagName();
+    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, 'div');
+
+    const resultValue = await resultPromise.value;
+    assert.strictEqual(resultValue, 'div');
+  });
+
   it('test .element().find().getTagName()', async function() {
     MockServer.addMock({
       url: '/session/13521-10219-202/element/1/name',
@@ -110,4 +134,5 @@ describe('element().getTagName() command', function () {
     assert.strictEqual(await resultPromise.assert.not.contains('dx'), 'div');
     assert.strictEqual(await resultPromise.assert.not.matches(/di[a-z]{2}x/), 'div');
   });
+
 });
diff --git a/types/tests/webElement.test-d.ts b/types/tests/webElement.test-d.ts
@@ -144,6 +144,7 @@ describe('new element() api', function () {
 
     expectType<ElementValue<string>>(elem.getId());
     expectType<ElementValue<string>>(elem.getTagName());
+    expectType<ElementValue<string>>(elem.tagName());
     expectType<ElementValue<string>>(elem.getText());
     expectType<ElementValue<string>>(elem.text());
 

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> {
   getLocation(): ElementValue<ScopedElementRect>;
 
   getTagName(): ElementValue<string>;
+  tagName(): ElementValue<string>;
 
   getText(): ElementValue<string>;
   text(): ElementValue<string>;