Class ContentAssist

constructor

• new ContentAssist(locators, parent): ContentAssist

• Parameters

  • locators: VSCodeLocatorMap

  • parent: DebugConsoleView | TextEditor

  Returns ContentAssist

elem$

elem$$

firstItem$

firstItem$$

itemLabel$

itemLabel$$

itemList$

itemList$$

itemRow$

itemRow$$

itemRows$

itemRows$$

itemText$

itemText$$

message$

message$$

elem

• get elem(): ChainablePromiseElement<Element>

• Base element of given page object

  Returns ChainablePromiseElement<Element>

locators

• get locators(): PageLocators

• Get the locator map of given page object

  Returns PageLocators

parent

• get parent(): ChainablePromiseElement<Element>

• Parent element of given page object

  Returns ChainablePromiseElement<Element>

getItem

• getItem(name): Promise<undefined | ContentAssistItem>

• Get content assist item by name/text, scroll through the list until the item is found, or the end is reached

  Parameters

  • name: string

    name/text to search by

  Returns Promise<undefined | ContentAssistItem>

  Promise resolving to ContentAssistItem object if found, undefined otherwise

getItems

• getItems(): Promise<ContentAssistItem[]>

• Get all visible content assist items

  Returns Promise<ContentAssistItem[]>

  Promise resolving to array of ContentAssistItem objects

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<ContentAssist>

• 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<ContentAssist>

  thenable self reference

select

• select(...path): Promise<undefined | Menu<{
      elem: string;
      firstItem: string;
      itemLabel: string;
      itemList: string;
      itemRow: string;
      itemRows: string;
      itemText: string;
      message: string;
  }>>

• 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<{
      elem: string;
      firstItem: string;
      itemLabel: string;
      itemList: string;
      itemRow: string;
      itemRows: string;
      itemText: string;
      message: string;
  }>>

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

wait

• wait(timeout?): Promise<ContentAssist>

• Wait for the element to become visible

  Parameters

  • timeout: number = 5000

    custom timeout for the wait

  Returns Promise<ContentAssist>

  thenable self reference