Class Menu<T>Abstract

Abstract element representing a menu

Type Parameters

  • T

Hierarchy (view full)

Accessors

elem locators parent

Methods

getItem getItems hasItem poll select wait

Accessors

elem

  • get elem(): ChainablePromiseElement<Element>

  • Base element of given page object

    Returns ChainablePromiseElement<Element>

locators

parent

  • get parent(): ChainablePromiseElement<Element>

  • Parent element of given page object

    Returns ChainablePromiseElement<Element>

Methods

Abstract getItem

  • getItem(name): Promise<undefined | MenuItem<T>>

  • Return a menu item of a given name, undefined if not found

    Parameters

    • name: string

      name of the item to search for

    Returns Promise<undefined | MenuItem<T>>

Abstract getItems

hasItem

  • hasItem(name): Promise<boolean>

  • Find whether the menu has an item of a given name

    Parameters

    • name: string

      name of the item to search for

    Returns Promise<boolean>

    true if menu has an item with the given name, false otherwise

poll

  • poll(timeout?, interval?): Promise<Menu<T>>

  • Poll for the element to become visible

    Parameters

    • timeout: number = 10000

      custom timeout for the wait

    • interval: number = 2000

      custom interval to control polling

    Returns Promise<Menu<T>>

    thenable self reference

select

  • select(...path): Promise<undefined | Menu<T>>

  • Recursively select an item with a given path.

    E.g. calling select('File', 'Preferences', 'Settings') will open the 'File' -> 'Preferences' submenus and then click on 'Settings'.

    Selection happens in order of the arguments, if one of the items in the middle of the path has no children, the consequent path arguments will be ignored.

    Parameters

    • Rest ...path: string[]

      path to the item to select, represented by a sequence of strings

    Returns Promise<undefined | Menu<T>>

    void if the last clicked item is a leaf, Menu item representing its submenu otherwise

wait

  • wait(timeout?): Promise<Menu<T>>

  • Wait for the element to become visible

    Parameters

    • timeout: number = 5000

      custom timeout for the wait

    Returns Promise<Menu<T>>

    thenable self reference

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc