Skip to content

Commit

Permalink
updated api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
beatfactor committed Sep 14, 2022
1 parent f7985d1 commit 52a8783
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 6 deletions.
10 changes: 5 additions & 5 deletions lib/api/element-commands/clearValue.js
Original file line number Diff line number Diff line change
@@ -1,9 +1,7 @@
const BaseElementCommand = require('./_baseElementCommand.js');

/**
* Clear a textarea or a text input element's value. Starting with v1.1 `clearValue()` will wait for the element to be present (until the specified timeout).
*
* If the element is not found, an error is thrown which will cause the test to fail. Starting with `v1.2` you can suppress element not found errors by specifying the `suppressNotFoundErrors` flag.
* Clear a textarea or a text input element's value.
*
* @example
* module.exports = {
Expand Down Expand Up @@ -32,8 +30,10 @@ const BaseElementCommand = require('./_baseElementCommand.js');
* }
*
* @method clearValue
* @syntax .clearValue(selector, [callback])
* @syntax .clearValue(using, selector, [callback])
* @syntax browser.clearValue('<SELECTOR>', function (result) { }])
* @syntax
* // using global element()
* browser.clearValue(element('<SELECTOR>'))
* @param {string} [using] The locator strategy to use. See [W3C Webdriver - locator strategies](https://www.w3.org/TR/webdriver/#locator-strategies)
* @param {string|object} selector The selector (CSS/Xpath) used to locate the element. Can either be a string or an object which specifies [element properties](https://nightwatchjs.org/guide#element-properties).
* @param {function} [callback] Optional callback function to be called when the command finishes.
Expand Down
2 changes: 1 addition & 1 deletion lib/api/element-commands/click.js
Original file line number Diff line number Diff line change
Expand Up @@ -53,4 +53,4 @@ class ClickElement extends BaseElementCommand {
}
}

module.exports = ClickElement;
module.exports = ClickElement;

0 comments on commit 52a8783

Please sign in to comment.