Add ariaRole() as alias for getAriaRole() (nightwatchjs#4159)

Co-authored-by: Priyansh Garg <[email protected]>
dikwickley · Oct 15, 2024 · 7d7fb61 · 7d7fb61
1 parent 5ae74f8
commit 7d7fb61
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 0 deletions.
diff --git a/lib/api/web-element/scoped-element.js b/lib/api/web-element/scoped-element.js
@@ -26,6 +26,7 @@ class ScopedWebElement {
       'getRect': ['getSize', 'getLocation', 'rect'],
       'getProperty': ['property'],
       'getCssProperty': ['css'],
+      'getAriaRole': ['ariaRole'],
       'isVisible': ['isDisplayed']
     };
   }

diff --git a/test/src/api/commands/web-element/testGetAriaRole.js b/test/src/api/commands/web-element/testGetAriaRole.js
@@ -38,6 +38,30 @@ describe('element().getAriaRole() command', function () {
     assert.strictEqual(resultValue, 'signupSection');
   });
 
+  it('test .element().ariaRole()', async function() {
+    MockServer.addMock({
+      url: '/session/13521-10219-202/element/0/computedrole',
+      method: 'GET',
+      response: JSON.stringify({
+        value: 'signupSection'
+      })
+    }, true);
+
+    const resultPromise = this.client.api.element('#signupSection').ariaRole();
+    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, 'signupSection');
+
+    const resultValue = await resultPromise.value;
+    assert.strictEqual(resultValue, 'signupSection');
+  });
+
   it('test .element().find().getAriaRole()', async function() {
     MockServer.addMock({
       url: '/session/13521-10219-202/element/1/computedrole',

diff --git a/types/tests/webElement.test-d.ts b/types/tests/webElement.test-d.ts
@@ -151,6 +151,7 @@ describe('new element() api', function () {
 
     expectType<ElementValue<string>>(elem.getAccessibleName());
     expectType<ElementValue<string>>(elem.getAriaRole());
+    expectType<ElementValue<string>>(elem.ariaRole());
     expectType<ElementValue<string>>(elem.getCssProperty('height'));
     expectType<ElementValue<string>>(elem.takeScreenshot());
 

diff --git a/types/web-element.d.ts b/types/web-element.d.ts
@@ -178,6 +178,7 @@ export interface ScopedElement extends Element, PromiseLike<WebElement> {
   getAccessibleName(): ElementValue<string>;
 
   getAriaRole(): ElementValue<string>;
+  ariaRole(): ElementValue<string>;
 
   getCssProperty(name: string): ElementValue<string>;