Add .attr() and .attribute() as alias for .getAttribute() comma…

…nd. (#4172) Co-authored-by: Priyansh Garg <[email protected]>
nightwatchjs · Apr 19, 2024 · 4efc6e3 · 4efc6e3
1 parent fb78d12
commit 4efc6e3
Show file tree

Hide file tree

Showing 4 changed files with 53 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'],
+      'getAttribute': ['attr', 'attribute'],
       'getProperty': ['property', 'prop'],
       'getText': ['text'],
       'getTagName': ['tagName'],

diff --git a/test/src/api/commands/web-element/testGetAttribute.js b/test/src/api/commands/web-element/testGetAttribute.js
@@ -38,6 +38,54 @@ describe('element().getAttribute() command', function () {
     assert.strictEqual(resultValue, 'text');
   });
 
+  it('test .element.attr() alias', async function() {
+    MockServer.addMock({
+      url: '/session/13521-10219-202/execute/sync',
+      method: 'POST',
+      response: JSON.stringify({
+        value: 'text'
+      })
+    }, true);
+
+    const resultPromise = this.client.api.element('#signupSection').attr('type');
+    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, 'text');
+
+    const resultValue = await resultPromise.value;
+    assert.strictEqual(resultValue, 'text');
+  });
+
+  it('test .element().attribute() alias', async function() {
+    MockServer.addMock({
+      url: '/session/13521-10219-202/execute/sync',
+      method: 'POST',
+      response: JSON.stringify({
+        value: 'text'
+      })
+    }, true);
+
+    const resultPromise = this.client.api.element('#signupSection').attribute('type');
+    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, 'text');
+
+    const resultValue = await resultPromise.value;
+    assert.strictEqual(resultValue, 'text');
+  });
+
   it('test .element().find().getAttribute()', async function() {
     MockServer.addMock({
       url: '/session/13521-10219-202/execute/sync',

diff --git a/types/tests/webElement.test-d.ts b/types/tests/webElement.test-d.ts
@@ -152,6 +152,8 @@ describe('new element() api', function () {
     expectType<ElementValue<string | null>>(elem.prop('property-name'));
     expectType<ElementValue<string | null>>(elem.property('property-name'));
     expectType<ElementValue<string | null>>(elem.getAttribute('attrib-name'));
+    expectType<ElementValue<string | null>>(elem.attr('attrib-name'));
+    expectType<ElementValue<string | null>>(elem.attribute('attrib-name'));
     expectType<ElementValue<string | null>>(elem.getValue());
     expectType<ElementValue<boolean>>(elem.isEnabled());
     expectType<ElementValue<boolean>>(elem.isVisible());

diff --git a/types/web-element.d.ts b/types/web-element.d.ts
@@ -168,6 +168,8 @@ export interface ScopedElement extends Element, PromiseLike<WebElement> {
   setProperty(name: string, value: unknown): Promise<WebElement>;
 
   getAttribute(name: string): ElementValue<string | null>;
+  attr(name: string): ElementValue<string | null>;
+  attribute(name: string): ElementValue<string | null>;
 
   setAttribute(name: string, value: string | null): Promise<WebElement>;