Interface LegacyApi

_abbr

• _abbr(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a area element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: area

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_above

• _above(anchor: SahiElementQueryOrWebElement, offset?: number): SahiRelation

• Creates a relation that identifies relational elements by the following criteria:

  • The center of the relational element is located above the center of the anchor element on the y axis
  • The relational element is vertically aligned with the anchor element

  example

  +----+
  | 3  |
  +----+
       :   +----+
       :   | 2  |
       :   +----+
       +----+
       | 1  |
       +----+
  

  In this case element 2 is "above" element 1 and element 3 is also "above" element 1, but element 3 is not "above" element 2 as they do not align vertically.

  Parameters

  • anchor: SahiElementQueryOrWebElement

  • Optional offset: number

  Returns SahiRelation

_activeElement

• _activeElement(): SahiElementQueryOrWebElement

• Create a query that resolves to the element which is currently focused

  CSS: :focus

  Returns SahiElementQueryOrWebElement

_areEqual

• _areEqual(query1: SahiElementQueryOrWebElement, query2: SahiElementQueryOrWebElement): Promise<boolean>

• Checks if two queries resolves to the same element.

  example

  Assume this HTML-snippet:

  <ul>
      <li>entry</li>
      <li>entry</li>
  </ul>
  

  Test the equality of two elements:

  // _listItem("entry") will fetch the first list item
  const equal = await _areEqual(_listItem(0), _listItem("entry")) // -> true
  const notEqual = await _areEqual(_listItem(1), _listItem("entry")) // -> false
  

  Parameters

  • query1: SahiElementQueryOrWebElement

  • query2: SahiElementQueryOrWebElement

  Returns Promise<boolean>

_area

• _area(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a area element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: area

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_article

• _article(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a article element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: article

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_aside

• _aside(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a aside element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: aside

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_assert

• _assert(condition: Promise<boolean>, message?: string): Promise<void>

• Throws an AssertionError when condition resolves to false

  Parameters

  • condition: Promise<boolean>

  • Optional message: string

    If the exception from this assertion is not handled, Sakuli will print and log this message.

  Returns Promise<void>

_assertContainsText

• _assertContainsText(expected: string, element: SahiElementQueryOrWebElement, message?: string): Promise<void>

• Throws an AssertionError when element doesn't contains text.

  Uses {@link FetchApi._containsText}

  Parameters

  • expected: string

  • element: SahiElementQueryOrWebElement

  • Optional message: string

  Returns Promise<void>

_assertEqual

• _assertEqual(expected: any, actual: any, message?: string): Promise<void>

• Throws an AssertionError when expected value doesn't deep strictly equals the actual value.

  Parameters

  • expected: any

  • actual: any

  • Optional message: string

  Returns Promise<void>

_assertEqualArrays

• _assertEqualArrays(expected: any[], actual: any[], message?: string): Promise<void>

• Basically the same as {@link AssertionApi._assertEqual} but only excepts arrays as èxpected and actual values.

  Parameters

  • expected: any[]

  • actual: any[]

  • Optional message: string

  Returns Promise<void>

_assertExists

• _assertExists(element: SahiElementQueryOrWebElement, message?: string): Promise<void>

• Throws an AssertionError when element doesn't exists in the current dom.

  Uses {@link FetchApi._exists}

  Parameters

  • element: SahiElementQueryOrWebElement

  • Optional message: string

  Returns Promise<void>

_assertFalse

• _assertFalse(condition: Promise<boolean>, message?: string): Promise<void>

• Opposite of {@link AssertionApi._assertTrue}.

  It throws an AssertionError when condition resolves to true

  Parameters

  • condition: Promise<boolean>

  • Optional message: string

  Returns Promise<void>

_assertNotContainsText

• _assertNotContainsText(expected: string, element: SahiElementQueryOrWebElement, message?: string): Promise<void>

• Throws an AssertionError when element contains text.

  Uses {@link FetchApi._containsText}

  Parameters

  • expected: string

  • element: SahiElementQueryOrWebElement

  • Optional message: string

  Returns Promise<void>

_assertNotEqual

• _assertNotEqual(expected: any, actual: any, message?: string): Promise<void>

• Throws an AssertionError when expected value deep strictly equals the actual value.

  Parameters

  • expected: any

  • actual: any

  • Optional message: string

  Returns Promise<void>

_assertNotExists

• _assertNotExists(element: SahiElementQueryOrWebElement, message?: string): Promise<void>

• Throws an AssertionError when element exists in the current dom.

  Uses {@link FetchApi._exists}

  Parameters

  • element: SahiElementQueryOrWebElement

  • Optional message: string

  Returns Promise<void>

_assertNotNull

• _assertNotNull(value: any, message?: string): Promise<void>

• Throws an AssertionError when value is null.

  Note that this method uses deep strict equality so that an undefined value will also pass the assertion.

  Parameters

  • value: any

  • Optional message: string

  Returns Promise<void>

_assertNotTrue

• _assertNotTrue(condition: Promise<boolean>, message?: string): Promise<void>

• Alias for {@link AssertionApi._assertFalse}

  Parameters

  • condition: Promise<boolean>

  • Optional message: string

    If the exception from this assertion is not handled, Sakuli will print and log this message.

  Returns Promise<void>

_assertNull

• _assertNull(value: any, message?: string): Promise<void>

• Throws an AssertionError when value is not null.

  Note that this method uses deep strict equality so that an undefined value will also fail the assertion.

  Parameters

  • value: any

  • Optional message: string

  Returns Promise<void>

_assertTrue

• _assertTrue(condition: Promise<boolean>, message?: string): Promise<void>

• Alias for {@link AssertionApi._assert}

  Parameters

  • condition: Promise<boolean>

  • Optional message: string

    If the exception from this assertion is not handled, Sakuli will print and log this message.

  Returns Promise<void>

_blockquote

• _blockquote(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a blockqoute element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: blockqoute

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_blur

• _blur(query: SahiElementQueryOrWebElement): Promise<void>

• Fetches an element and performs the native .blur() in the browser. That means that this element will lose the focus-state.

  Parameters

  • query: SahiElementQueryOrWebElement

  Returns Promise<void>

  Resolves when browser-script finished

_bold

• _bold(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a bold element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: b

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_button

• _button(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a button by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: button

  example

  Assuming the following HTML-snippet

  <button>Click Me</button>
  

  Invoking a click on this button:

  await _click(_button('Click Me'));
  

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_byClassName

• _byClassName(clsName: string, tagName: string): SahiElementQueryOrWebElement

• Fetches an element of TagName with clsName in it's classList attribute

  Based on CSS selector: tagName.clsName

  example

  
  Assuming this HTML-snippet:

      <p class="leading class2">Lorem ipsum</p>
  

  Can be highlighted like this:

     // will highlight the paragraph above
     await _highlight(_byClassName('leading', 'p'));
  
  

  Parameters

  • clsName: string

  • tagName: string

  Returns SahiElementQueryOrWebElement

_byId

• _byId(id: string): SahiElementQueryOrWebElement

• Fetches an element by it's id attribute. If the id of an element i known and somehow stable in the dom (not generated by an CMS for example) this is the recommended way to query an element because it is the fastest.

  Parameters

  • id: string

    id of the element. Like document.getElementById(id)

  Returns SahiElementQueryOrWebElement

_byText

• _byText(text: string, tagName: string): SahiElementQueryOrWebElement

• Fetches an element of tagName with the given text

  Parameters

  • text: string

  • tagName: string

  Returns SahiElementQueryOrWebElement

_byXPath

• _byXPath(xPath: string): SahiElementQueryOrWebElement

• Fetches an element by a xPath-expression on the current webpage.

  example

  Assuming the following HTML-snippet:

      <ul>
        <li>Item 1</li>
        <li>Item 2</li>
        <li>Item 3</li>
      </ul>
  

  Fetching the second item from the list:

      const item2 = await _fetch(_byXPath('/ul/li[2]'));
  

  Parameters

  • xPath: string

  Returns SahiElementQueryOrWebElement

_canvas

• _canvas(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a canvas element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: canvas

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_cell

• _cell(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a table-data element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: td

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_check

• _check(query: SahiElementQueryOrWebElement): Promise<void>

• Performs a click on a checkbox input and forces its state to be checked

  Parameters

  • query: SahiElementQueryOrWebElement

  Returns Promise<void>

_checkbox

• _checkbox(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a checkbox field by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: input[type="checkbox"]

  example

  Assuming the following HTML-snippet:

  <label>
      <input type="checkbox" name="like-pizza">
      <span>Like Pizza?</span>
  </label>
  

  Checking the field with [_check]{@link MouseActionApi._check}:

  await _check(_checkbox('like-pizza'));
  

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_click

• _click(query: SahiElementQueryOrWebElement, combo?: string | ClickOptions, options?: ClickOptions): Promise<void>

• _click simulates a user's click on the given element.

  example

  
  

  _click(_button("Click Me"));
  _click(_button("Click Me"), "CTRL"); // clicks with CTRL key pressed
  _click(_button("Click Me"), "CTRL|SHIFT"); // clicks with CTRL and SHIFT keys pressed
  _click(_button("Click Me"), {force: true}); // clicks without validation
  _click(_button("Click Me"), "CTRL", {force: true}); //clicks with CTRL without validation
  

  Parameters

  • query: SahiElementQueryOrWebElement

    query to the Element to click on

  • Optional combo: string | ClickOptions

    Optional combo key(s): can be CTRL, SHIFT, ALT or META; Can also be two or more keys together like "CTRL|SHIFT"

  • Optional options: ClickOptions

    disables validations prior to the click action to enforce clicks where an element e.g. is covered

  Returns Promise<void>

  Resolves after the click is invoked, doesn't wait for further actions on the website which are possibly invoked after the click

_code

• _code(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a code element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: code

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_collect

• _collect(accessorApiMethod: AccessorFunctions, identifier: AccessorIdentifier, ...relations: SahiRelation[]): Promise<WebElement[]>

• Collects all specified elements

  example

  Assuming the following HTML-snippet:

      <div class="city">Los Angeles</div>
      <div class="city>Berlin</div>
  

  Highlights the div containing second city:

      const cities = await _collect('_div', 'city');
  
      await _highlight(cities[1]);
  

  Parameters

  • accessorApiMethod: AccessorFunctions

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns Promise<WebElement[]>

_contains

• _contains(parent: SahiElementQueryOrWebElement, child: SahiElementQueryOrWebElement): Promise<boolean>

• Check if a parent element contains a child element.

  example

  Assume the following HTML-snippet:

  <div id="parent">
      <div id="child-a"></div>
      <div id="child-b"></div>
  </div>
  

  Check if an element is the contained within another

  await _contains(_div('parent'), _div('child-b')) // -> true
  await _contains(_div('child-a'), _div('child-b')) // -> false
  

  Parameters

  • parent: SahiElementQueryOrWebElement

  • child: SahiElementQueryOrWebElement

  Returns Promise<boolean>

_containsHTML

• _containsHTML(query: SahiElementQueryOrWebElement, html: string): Promise<boolean>

• Compares the .innerHTML of an element with the given html string. Both .innerHTML and the snippet are unified using the html function from common-tags library.

  example

  Assume the following HTML-snippet:

  <div id="d1" style="background-color: yellow"><i>Formatted</i> Text</div>
  

  Check if an element contains certain HTML:

  await _containsHTML(_div(0), '<i>Formatted</i>'); // -> true
  await _containsHTML(_div(0), 'Text'); // -> true
  await _containsHTML(_div(0), '<i>Formatted</i> Text'); // -> true
  await _containsHTML(_div(0), '<i>.*</i>'); // -> true
  await _containsHTML(_div(0), 'Formatted Text'); // -> false
  await _containsHTML(_div(0), 'Non existent'); // -> false
  

  Parameters

  • query: SahiElementQueryOrWebElement

  • html: string

  Returns Promise<boolean>

_containsText

• _containsText(query: SahiElementQueryOrWebElement, text: string): Promise<boolean>

• Checks if the displayed text of the element contains the given text. The text parameter is turned into an RegExp object before performing the check.

  example

  Assume following HTML-snippet:

  <p ="intro">
  Lorem ipsum dolor sit amet. consetetur sadipscing elitr
  </p>
  <!-- Inner HTML-tags are stripped -->
  <div>Hello <i>World</i></div>
  <div id="pending-request">
      There are 5 pending request
  </div>
  

  Check if a element contains certain text:

  const containsIpsumDolor = await _containsText(_paragraph('intro'), 'ipsum dolor') // -> true
  const containsYpsumDolor = await _containsText(_paragraph('intro'), 'ypsum dolor') // -> false
  
  const containsText = await _containsText(_div(0), 'Hello World'); // -> true
  
  const probablyDynamicText = await _containsText(_div('pending-request'), "There are . pending requests"); // -> true
  

  Parameters

  • query: SahiElementQueryOrWebElement

  • text: string

  Returns Promise<boolean>

_count

• _count(accessorApiMethod: AccessorFunctions, identifier: AccessorIdentifier, ...relations: SahiRelation[]): Promise<number>

• Counts all specified elements

  example

  Assuming the following HTML-snippet:

      <div class="city">Los Angeles</div>
      <div class="city>Berlin</div>
  

  Logs the city count into sakuli.log:

      const cityCount = await _count('_div', 'city');
  
      Logger.logInfo(`${cityCount} cities found`);
  

  Parameters

  • accessorApiMethod: AccessorFunctions

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns Promise<number>

_dDesc

• _dDesc(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a definition-description element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: dd

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_dList

• _dList(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a definition-list element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: dl

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_dTerm

• _dTerm(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a definition-term element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: dt

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_datebox

• _datebox(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a date field by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: input[type="date"]

  If you want to set a value on this element please consider the supported formats

  example

  Assuming the following HTML-snippet:

     <input type="date" name="date-input" />
  

  Setting the value of this field:

     await _setValue(_datebox('date-input'), '2019-07-22')
  

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_datetimebox

• _datetimebox(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a datetime field by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: input[type="datetime"]

  If you want to set a value on this element please consider the supported formats

  example

  Assuming the following HTML-snippet:

     <input type="datetime" name="date-input" />
  

  Setting the value of this field:

     await _setValue(_datetimebox('date-input'), '2019-07-22T19:30')
  

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_datetimelocalbox

• _datetimelocalbox(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a datetime-local field by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: input[type="datetime-local"]

  If you want to set a value on this element please consider the supported formats

  example

  Assuming the following HTML-snippet:

     <input type="datetime-local" name="date-input" />
  

  Setting the value of this field:

     await _setValue(_datetimelocalbox('date-input'), '2019-07-22T19:30')
  

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_details

• _details(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a details element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: details

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_div

• _div(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a div element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: div

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_dragDrop

• _dragDrop(eSource: SahiElementQueryOrWebElement, eTarget: SahiElementQueryOrWebElement): Promise<void>

• Performs a mouse down on eSource, than moves the mouse to the position of element eTarget and releases the mouse button at this position.

  This implementation uses Webdriver actions which does not always behave as expected.

  For a more reliable experience ThenableRegion.dragAndDropTo is recommended.

  Parameters

  • eSource: SahiElementQueryOrWebElement

  • eTarget: SahiElementQueryOrWebElement

  Returns Promise<void>

_dragDropXY

• _dragDropXY(q: SahiElementQueryOrWebElement, x: number, y: number, $isRelative?: boolean): Promise<void>

• Performs a mouse down on eSource, than moves the mouse to the position P(x,y) in the browsers' viewport and releases the mouse button at this position.

  This implementation uses Webdriver actions which does not always behave as expected.

  For a more reliable experience ThenableRegion.dragAndDropTo is recommended.

  Parameters

  • q: SahiElementQueryOrWebElement

  • x: number

  • y: number

  • Optional $isRelative: boolean

  Returns Promise<void>

_dynamicInclude

• _dynamicInclude(): Promise<void>

• A relic from Sakuli v1, that was used load

  deprecated

  Returns Promise<void>

_emailbox

• _emailbox(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a email field by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: input[type="email"]

  example

  Assuming the following HTML-snippet:

     <input type="email" name="mail-input" />
  

  Setting the value of this field:

     await _setValue(_emailbox('mail-input'), 'do-not-spam@sakuli.io')
  

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_embed

• _embed(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a embed element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: embed

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_emphasis

• _emphasis(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches an emphasis element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: em

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_exists

• _exists(query: SahiElementQueryOrWebElement): Promise<boolean>

• Resolves to true / false when the element can be found in the DOM or not.

  example

  Assume this HTML-snippet:

  <div>Hello</div>
  

  Determine if an element is present in the current DOM:

  const present = await _exists(_div("Hello")); // -> true
  const absent = await _exists(_div("World")); // -> false
  

  Parameters

  • query: SahiElementQueryOrWebElement

  Returns Promise<boolean>

_fetch

• _fetch(query: SahiElementQueryOrWebElement): Promise<WebElement>

• Executes the given query and returns a "native" WebElement instance when the query is successful.

  Parameters

  • query: SahiElementQueryOrWebElement

  Returns Promise<WebElement>

_fieldset

• _fieldset(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a fieldset element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: fieldset

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_figcaption

• _figcaption(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a figcaption element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: figcaption

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_figure

• _figure(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a figure element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: figure

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_file

• _file(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a file input by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: input[type="file"]

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_focus

• _focus(query: SahiElementQueryOrWebElement): Promise<void>

• Fetches an element and performs the native .focus() method in the browser. When _focus is performed on an <input> element, it will be automatically scrolled into the viewport by the browser.

  Note that not all elements will get an actual focus in the browser. Usually links and user-controls (e.g. <input>, <textarea>, <select>...) can gain focus.

  Parameters

  • query: SahiElementQueryOrWebElement

    Query or concrete WebElement

  Returns Promise<void>

  Resolves when browser-script finished

_font

• _font(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a font element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: font

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_footer

• _footer(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a footer element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: footer

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_frame

• _frame(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a frame element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: frame

  deprecated

  Frames are even deprecated in HTML itself. Anyway some legacy pages are still using this technology. To access elements in a frame, the same method as described for [_iframe]{@link AccessorApi._iframe} can be used.

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_getAttribute

• _getAttribute(query: SahiElementQueryOrWebElement, name: string): Promise<string>

• Retrieves the value of an element attribute.

  example

  Assume this HTML-snippet:

  <div
      data-testid="foo-element"
      class="widget primary"
  >Foo bar</div>
  

  Accessing the values of div attributes:

  const dataTestId = await _getAttribute(_div(/Foo bar/), 'data-testid'); // -> "foo-element"
  const classNames = await _getAttribute(_div(/Foo bar/), 'class'); // -> "widget primary"
  

  Parameters

  • query: SahiElementQueryOrWebElement

  • name: string

  Returns Promise<string>

_getCellText

• _getCellText(query: SahiElementQueryOrWebElement): Promise<string>

• Alias for {@link FetchApi._getText}.

  Parameters

  • query: SahiElementQueryOrWebElement

  Returns Promise<string>

_getFetchTimeout

• _getFetchTimeout(): number

• Gets the maximum time Sakuli will try to find an element on dom.

  Returns number

_getOptions

• _getOptions(query: SahiElementQueryOrWebElement, value?: "value"): Promise<string[]>

• Finds all option elements within the queried element and resolves to an array with all visible texts of the options. If the parameter value is set to "value" it will resolve to an array with all option values.

  example

  Assume this HTML-snippet:

  <select name="answers">
      <option value="a-yes">Yes</option>
      <option value="a-no">No</option>
      <option value="a-maybe">Maybe</option>
  </select>
  

  Accessing either to displayed text or the actual values of the options:

  const optionTexts = await _getOptions(_select('answers')); // -> ['Yes', 'No', 'Maybe']
  const optionValues = await _getOptions(_select('answers'), "value"); // -> ['a-yes', 'a-no', 'a-maybe']
  

  Parameters

  • query: SahiElementQueryOrWebElement

  • Optional value: "value"

  Returns Promise<string[]>

_getSelectedText

• _getSelectedText(query: SahiElementQueryOrWebElement): Promise<string>

• Retrieves the text content of the selected option within the select element.

  example

  Assume this HTML-snippet:

  <select name="answers">
      <option value="a-yes">Yes</option>
      <option value="a-no">No</option>
      <option selected="selected" value="a-maybe">Maybe</option>
      <!-- Selected attribute is also set if the user (or Sakuli) selects the option in the browser -->
  </select>
  

  Accessing either the displayed text or the actual value of the options:

  const selectedOptionText = await _getSelected(_select('answers')); // -> 'a-maybe'
  

  Parameters

  • query: SahiElementQueryOrWebElement

  Returns Promise<string>

_getSelectionText

• _getSelectionText(): Promise<string>

• Retrieves the selection from a user in the current document as a string. This is most likely the text what will set to the clipboard if a user copies the selection.

  Returns Promise<string>

_getText

• _getText(query: SahiElementQueryOrWebElement): Promise<string>

• Gets the visible (i.e. not hidden by CSS) innerText of this element, including sub-elements, without any leading or trailing whitespace. It uses WebElement.getText() method internally.

  Parameters

  • query: SahiElementQueryOrWebElement

  Returns Promise<string>

_getValue

• _getValue(query: SahiElementQueryOrWebElement): Promise<string>

• Retrieves the actual value from the value attribute of an [Element or Query]{@link SahiElementQueryOrWebElement}.

  example

  Assume this HTML-snippet:

  <input type="text" name="with-value" value="Hello World" />
  <div id="without-value"></div>
  

  Accessing the value of [value]

  const valueFromInput = await _getValue(_textbox('with-value')); // -> "Hello World"
  const noValue = await _getValue(_div('without-value')); // -> undefined
  

  Parameters

  • query: SahiElementQueryOrWebElement

  Returns Promise<string>

_header

• _header(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a header element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: header

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_heading1

• _heading1(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a heading element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: h1

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_heading2

• _heading2(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a heading element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: h2

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_heading3

• _heading3(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a heading element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: h3

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_heading4

• _heading4(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a heading element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: h4

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_heading5

• _heading5(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a heading element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: h5

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_heading6

• _heading6(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a heading element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: h6

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_hidden

• _hidden(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a hidden field by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: input[type="hidden"]

  example

  Assuming the following HTML-snippet:

     <input type="hidden" name="hidden-input" />
  

  Setting the value of this field:

     await _setValue(_hidden('hidden-input'), 'some data')
  

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_highlight

• _highlight(query: SahiElementQueryOrWebElement, timeoutMs?: number): Promise<void>

• Draws a red border around an element on the website.

  This is useful for debugging and demonstrating reasons. Note that the timeout of this highlight will increase the actual execution time of the current step.

  Parameters

  • query: SahiElementQueryOrWebElement

    The element to be highlighted

  • Optional timeoutMs: number

    determine how long the highlight will last (default: 2000)

  Returns Promise<void>

_hr

• _hr(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a horizontal-ruler element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: hr

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_iframe

• _iframe(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a iframe element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: iframe

  example

  Accessing a Iframe: ``

  <!-- embeded.html -->
  <button>Button in a frame</button>
  
  <!-- page.html -->
  <iframe src="embeded.html" />
  

  Sakuli can also access contents from an Iframe using the WebDriver-instance

  await _navigateTo('page.html'); // 1.
  const iFrame = await _fetch(_iframe(0)); // 2.
  await driver.switchTo().frame(iFrame); // 3.
  await _click(_button('Button in a frame')); // 4.
  await driver.switchTo().defaultContent();
  

  1. Assuming that Sakuli is navigated to page that contains an iframe
  2. Fetch an instance of seleniums WebElement using [_fetch]{@link FetchApi._fetch}
  3. Using seleniums switchTo().frame() to change the context to the iframe
  4. Now elements within the iframe page are accessible
  5. Switching back to the "main-frame"

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_image

• _image(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches an image by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: img

  example

  Assuming the following HTML-snippet:

  <img src="funny-cat.gif" title="" />
  

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_imageSubmitButton

• _imageSubmitButton(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a image button by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: input[type="image"]

  example

  Assuming the following HTML-snippet:

  <form>
      <label>User: <input type="text" name="username" /></label>
      <label>Password: <input type="password" name="password" /></label>
      <input type="image" src="cool-button.png" name="login" />
  </form>
  

  Submitting the form with a [_click]{@link MouseActionApi._click}

  await _click(_imageSubmitButton('login'));
  

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_in

• _in(anchor: SahiElementQueryOrWebElement): SahiRelation

• Creates a relation that specifies elements inside the anchor element.

  example

  
  Assuming this HTML-snippet:

  <b>something</b>
  <div id="div1">
    <b>something</b>
  </div>
  

  The following expression returns the second bold element.

  await _bold("something", _in(_byId("div1")));
  

  Parameters

  • anchor: SahiElementQueryOrWebElement

  Returns SahiRelation

_isChecked

• _isChecked(query: SahiElementQueryOrWebElement): Promise<boolean>

• Checks if the element has an attribute checked. This is useful for checkboxes or radio inputs.

  example

  Assume this HTML-snippet:

     <input type="radio" name="payment" value=debit-card" />
     <input type="radio" name="payment" value="cash" />
  

  Checks if a radio input is checked or not:

  const checked = await _isChecked(_radio(0)); // -> true
  const notChecked = await _isChecked(_radio(1)); // -> false
  

  Parameters

  • query: SahiElementQueryOrWebElement

  Returns Promise<boolean>

_isEnabled

• _isEnabled(query: SahiElementQueryOrWebElement): Promise<boolean>

• Checks if an element is enabled. An element is considered as enabled when it has no disabled attribute set.

  example

  Assume this HTML-snippet:

  <input type="text" id="enabled-input" />
  <input type="text" disabled id="disabled-input" />
  

  Check if the inputs are enabled:

  const enabled = await _isEnabled(_textbox('enabled-input')); // -> true
  const disabled = await _isEnabled(_textbox('disabled-input')); // -> false
  

  Parameters

  • query: SahiElementQueryOrWebElement

  Returns Promise<boolean>

_isVisible

• _isVisible(query: SahiElementQueryOrWebElement): Promise<boolean>

• Tests if this element is currently displayed. Using a timeout of maximum one second. If a longer timeout is needed, {@link ActionApi._wait} can be used. It uses WebElement.isDisplayed internally.

  example

  Assume this HTML-snippet:

  <div>Hello World</div>
  <div style="display: none">Ninja Element</div>
  

  Testing the visibility of the elements:

  const visible = await _isVisible(_div("Hello World")) // -> true
  const invisible = await _isVisible(_div("Ninja Element")) // -> false
  
  // Waits at most 5 seconds until element is visible
  
  await _wait(5000, () => _isVisible(_div('Hello World')));
  
  

  Parameters

  • query: SahiElementQueryOrWebElement

  Returns Promise<boolean>

_italic

• _italic(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a italic element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: i

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_keyDown

• _keyDown(query: SahiElementQueryOrWebElement, charInfo: CharInfo, combo?: string): Promise<void>

• Invokes a single keydown event on the given element. This is useful if you want to invoke a certain event which relies on the keydown event. In most cases it has to be used together with {@link KeyboardActionsApi._keyUp}

  Parameters

  • query: SahiElementQueryOrWebElement

  • charInfo: CharInfo

  • Optional combo: string

    Optional combo key(s): can be CTRL, SHIFT, ALT or META; Can also be two or more keys together like "CTRL|SHIFT"

  Returns Promise<void>

_keyPress

• _keyPress(query: SahiElementQueryOrWebElement, charInfo: CharInfo, combo?: string): Promise<void>

• Performs a single keystroke ('keypress'-event) on the element.

  example

  Performing CTRL+s on an (imaginary) web-based word-processor element:

  await _keyPress(_byId('word-processor-canvas'), 's', 'CTRL')
  

  Parameters

  • query: SahiElementQueryOrWebElement

  • charInfo: CharInfo

  • Optional combo: string

    Optional combo key(s): can be CTRL, SHIFT, ALT or META; Can also be two or more keys together like "CTRL|SHIFT"

  Returns Promise<void>

_keyUp

• _keyUp(query: SahiElementQueryOrWebElement, charInfo: CharInfo): Promise<void>

• Invokes a single keyup event with the given element. This is only useful when {@link KeyboardActionsApi._keyDown} is invoked previously. Some WebDrivers like Firefox will not trigger any event if there was no keypress before.

  Parameters

  • query: SahiElementQueryOrWebElement

  • charInfo: CharInfo

  Returns Promise<void>

_label

• _label(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a label element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: label

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_leftOf

• _leftOf(anchor: SahiElementQueryOrWebElement, offset?: number): SahiRelation

• Creates a relation that identifies relational elements by the following criteria:

  • The center of the relational element is located left of the center of the anchor element on the x axis
  • The relational element is horizontally aligned with the anchor element

  +----+
  | 1  |
  +----+ ~~~~~~~~~ +----+
          +----+ ~ | 3  |
          | 2  |   +----+
          +----+
  

  In this case element 1 and element 2 are "left of" element 3, but element 1 is not "left of" element 2 as they do not align horizontally.

  Parameters

  • anchor: SahiElementQueryOrWebElement

  • Optional offset: number

  Returns SahiRelation

_leftOrRightOf

• _leftOrRightOf(anchor: SahiElementQueryOrWebElement, offset?: number): SahiRelation

• Creates a relation that identifies relational elements by the following criteria:

  • The center of the relational element is located left or right of the center of the anchor element on the x axis
  • The relational element is horizontally aligned with the anchor element

  +----+
  | 1  |
  +----+ ~~~~~~~~~ +----+
                   | 3  | ~ +----+
                   +----+   | 2  |
   +----+                   +----+
   | 4  |
   +----+
  

  In this case element 1 and element 2 are "left or right of" element 3, but element 4 is not "left or right of" element 3 as they do not align horizontally.

  Parameters

  • anchor: SahiElementQueryOrWebElement

  • Optional offset: number

  Returns SahiRelation

_link

• _link(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a anchor / link element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: a

  example

  Assuming the following HTML-snippet:

  <nav>
      <a href="/home">Home</a>
      <a href="/home">About</a>
  </nav>
  

  Following the "About" link with [_click]{@link MouseActionApi._click}

  await _click(_link('About'))
  

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_list

• _list(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches an unordered list element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: ul

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_listItem

• _listItem(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a list-item element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: li

  example

  Assuming the following HTML-snippet:

  <ul>
      <li>Pizza</li>
      <li>Burger</li>
      <li lang="de">Bratwurst</li>
  </ul>
  

  const lang = await _getAttribute(_listItem('Bratwurst'), 'lang'); // -> 'de'
  

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_main

• _main(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a main element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: main

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_map

• _map(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a map element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: map

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_mark

• _mark(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a mark element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: mark

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_monthbox

• _monthbox(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a month field by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: input[type="month"]

  If you want to set a value on this element please consider the supported formats

  example

  Assuming the following HTML-snippet:

     <input type="month" name="month-input" />
  

  Setting the value of this field:

     await _setValue(_monthbox('month-input'), '2019-07')
  

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_mouseDown

• _mouseDown(query: SahiElementQueryOrWebElement, isRight?: boolean, combo?: string): Promise<void>

• Performs a press action on the element

  see

  https://seleniumhq.github.io/selenium/docs/api/javascript/module/selenium-webdriver/lib/input_exports_Actions.html

  Parameters

  • query: SahiElementQueryOrWebElement

  • Optional isRight: boolean

    Indicates that the right mousebutton is pressed

  • Optional combo: string

    Any combo key: can be "CTRL", "SHIFT", "ALT" or "META"; Can also be two or more keys together like "CTRL|SHIFT"

  Returns Promise<void>

_mouseOver

• _mouseOver(query: SahiElementQueryOrWebElement, combo?: string): Promise<void>

• Invokes a mouse over on the queried element. Can be combined with a key combo.

  Parameters

  • query: SahiElementQueryOrWebElement

  • Optional combo: string

    Optional combo key(s): can be CTRL, SHIFT, ALT or META; Can also be two or more keys together like "CTRL|SHIFT"

  Returns Promise<void>

_mouseUp

• _mouseUp(query: SahiElementQueryOrWebElement, isRight?: boolean, combo?: string): Promise<void>

• Performs a release action on the element. Release is the action when a user releases his finger from the mouse button.

  see

  https://seleniumhq.github.io/selenium/docs/api/javascript/module/selenium-webdriver/lib/input_exports_Actions.html

  Parameters

  • query: SahiElementQueryOrWebElement

  • Optional isRight: boolean

    Indicates that the right mousebutton is released

  • Optional combo: string

    Optional combo key(s): can be CTRL, SHIFT, ALT or META; Can also be two or more keys together like "CTRL|SHIFT"

  Returns Promise<void>

_nav

• _nav(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a nav element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: nav

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_navigateTo

• _navigateTo(target: string, forceReload?: boolean, credentials?: { password: string; user: string }): Promise<any>

• Navigates the browser instance to the given URL (also Data URLs are possible).

  example

  // open sakuli.io in the browser
  await _navigateTo("https://sakuli.io");
  
  
  // navigate and authenticate on a page with http-basic
  await _navigateTo("https://sakuli.io/fictional-admin", false, {user: 'UserName', password: 'top$ecret'})
  

  It uses ThenableWebdriver.get() under the hood.

  Parameters

  • target: string

    The URL of the Website to test - Could be any string that can be entered in a browser navigationbar

  • Optional forceReload: boolean

    Forces the page to reload after it has been loaded - it is a relict of Sahi. Default: false

  • Optional credentials: { password: string; user: string }

    If a site requires "Http-Basic-Authentication" you can pass the credentials here

    • password: string

    • user: string

  Returns Promise<any>

_near

• _near(anchor: SahiElementQueryOrWebElement): SahiRelation

• Creates a relation which returns the given element nearest (distance within the DOM tree) to the anchor

  example

  Assuming the following HTML-snippets

  <div>
     <p id="elem0">elem</p>
     <p id="elem1">elem</p>
     <p id="anchor"></p>
  </div>
  

  <div>
   <div>
     <p id="elem0">elem</p>
     <p id="elem1">elem</p>
   </div>
   <p id="anchor"></p>
  </div>
  

  The following query will return in both cases the element with id="elem0"

  _paragraph("elem", _near(_paragraph("anchor"));
  

  Parameters

  • anchor: SahiElementQueryOrWebElement

  Returns SahiRelation

_numberbox

• _numberbox(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a number field by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: input[type="number"]

  If you want to set a value on this element please consider the supported formats

  example

  Assuming the following HTML-snippet:

     <input type="number" name="number-input" />
  

  Setting the value of this field:

     await _setValue(_numberbox('number-input'), 5)
  

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_object

• _object(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches a object element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: object

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_option

• _option(identifier: AccessorIdentifier, ...relations: SahiRelation[]): SahiElementQueryOrWebElement

• Fetches an option element by an [identifier]{@link AccessorIdentifier} - restricted by the [relations]{@link RelationApi}

  Based on CSS selector: select

  example

  Assuming the following HTML-snippet

  <select name="preferred-drink">
      <option value="water" selected>Water</option>
      <option value="wine">Wine</option>
      <option value="beer">Beer</option>
  </select>
  

  Detect if an option is visible with [_isVisible]{@link FetchApi._isVisible}

  await _isVisible(_option('Wine')); // -> false
  

  Parameters

  • identifier: AccessorIdentifier

  • Rest ...relations: SahiRelation[]

  Returns SahiElementQueryOrWebElement

_pageIsStable

• _pageIsStable(timeout?: number, interval?: number): Promise<boolean>

• Continuously fetches the page source and checks for DOM changes. Will be repeated every $timeout milliseconds until either the DOM does no longer change or $timeout is reached

  example

  // Wait for a stable DOM with default timeout and interval, continue test execution if it does not stabilize within timeout
  await _pageIsStable();
  
  // Wait for a stable DOM with custom timeout and default interval, continue test execution if it does not stabilize within timeout
  await _pageIsStable(5000);
  
  // Wait for a stable DOM with custom timeout and custom interval, continue test execution if it does not stabilize within timeout
  await _pageIsStable(5000, 100);
  
  // Wait for a stable DOM, stop test execution if it does not stabilize within timeout
  await _assertTrue(_pageIsStable(5000, 100));
  

  Parameters

  • Optional timeout: number

    Maximum timout in ms to wait for DOM stabilization. Default: 2000 ms

  • Optional interval: number

    Interval between stability checks in ms. Default: 200 ms

  Returns Promise<boolean>

_paragraph