Page object representing the internal VSCode settings editor

Hierarchy (view full)

Constructors

Properties

action$: ((...args) => ChainablePromiseElement<Element>)

Type declaration

    • (...args): ChainablePromiseElement<Element>
    • Parameters

      • Rest ...args: [label: string]

      Returns ChainablePromiseElement<Element>

action$$: ((...args) => ChainablePromiseArray<Element[]>)

Type declaration

    • (...args): ChainablePromiseArray<Element[]>
    • Parameters

      • Rest ...args: [label: string]

      Returns ChainablePromiseArray<Element[]>

actionContainer$: ChainablePromiseElement<Element>
actionContainer$$: ChainablePromiseArray<Element[]>
actionItem$: ChainablePromiseElement<Element>
actionItem$$: ChainablePromiseArray<Element[]>
actions$: ChainablePromiseElement<Element>
actions$$: ChainablePromiseArray<Element[]>
activeTab$: ChainablePromiseElement<Element>
activeTab$$: ChainablePromiseArray<Element[]>
breakPoint$: ChainablePromiseElement<Element>
breakPoint$$: ChainablePromiseArray<Element[]>
checkboxChecked$: ChainablePromiseElement<Element>
checkboxChecked$$: ChainablePromiseArray<Element[]>
checkboxSetting$: ChainablePromiseElement<Element>
checkboxSetting$$: ChainablePromiseArray<Element[]>
closeTab$: ChainablePromiseElement<Element>
closeTab$$: ChainablePromiseArray<Element[]>
comboOption$: ChainablePromiseElement<Element>
comboOption$$: ChainablePromiseArray<Element[]>
comboSetting$: ChainablePromiseElement<Element>
comboSetting$$: ChainablePromiseArray<Element[]>
dataUri$: ChainablePromiseElement<Element>
dataUri$$: ChainablePromiseArray<Element[]>
debugHint$: ChainablePromiseElement<Element>
debugHint$$: ChainablePromiseArray<Element[]>
diffEditor$: ChainablePromiseElement<Element>
diffEditor$$: ChainablePromiseArray<Element[]>
editorContainer$: ChainablePromiseElement<Element>
editorContainer$$: ChainablePromiseArray<Element[]>
editorGroup$: ChainablePromiseElement<Element>
editorGroup$$: ChainablePromiseArray<Element[]>
elem$: ChainablePromiseElement<Element>
elem$$: ChainablePromiseArray<Element[]>
findWidget$: ChainablePromiseElement<Element>
findWidget$$: ChainablePromiseArray<Element[]>
formatDoc$: ChainablePromiseElement<Element>
formatDoc$$: ChainablePromiseArray<Element[]>
header$: ChainablePromiseElement<Element>
header$$: ChainablePromiseArray<Element[]>
inputArea$: ChainablePromiseElement<Element>
inputArea$$: ChainablePromiseArray<Element[]>
itemCount$: ChainablePromiseElement<Element>
itemCount$$: ChainablePromiseArray<Element[]>
itemRow$: ChainablePromiseElement<Element>
itemRow$$: ChainablePromiseArray<Element[]>
lineNumber$: ((...args) => ChainablePromiseElement<Element>)

Type declaration

    • (...args): ChainablePromiseElement<Element>
    • Parameters

      • Rest ...args: [line: number]

      Returns ChainablePromiseElement<Element>

lineNumber$$: ((...args) => ChainablePromiseArray<Element[]>)

Type declaration

    • (...args): ChainablePromiseArray<Element[]>
    • Parameters

      • Rest ...args: [line: number]

      Returns ChainablePromiseArray<Element[]>

lineOverlay$: ((...args) => ChainablePromiseElement<Element>)

Type declaration

    • (...args): ChainablePromiseElement<Element>
    • Parameters

      • Rest ...args: [line: number]

      Returns ChainablePromiseElement<Element>

lineOverlay$$: ((...args) => ChainablePromiseArray<Element[]>)

Type declaration

    • (...args): ChainablePromiseArray<Element[]>
    • Parameters

      • Rest ...args: [line: number]

      Returns ChainablePromiseArray<Element[]>

linkButton$: ChainablePromiseElement<Element>
linkButton$$: ChainablePromiseArray<Element[]>
marginArea$: ChainablePromiseElement<Element>
marginArea$$: ChainablePromiseArray<Element[]>
modifiedEditor$: ChainablePromiseElement<Element>
modifiedEditor$$: ChainablePromiseArray<Element[]>
originalEditor$: ChainablePromiseElement<Element>
originalEditor$$: ChainablePromiseArray<Element[]>
selection$: ChainablePromiseElement<Element>
selection$$: ChainablePromiseArray<Element[]>
settingConstructor$: ((...args) => ChainablePromiseElement<Element>)

Type declaration

    • (...args): ChainablePromiseElement<Element>
    • Parameters

      • Rest ...args: [title: string, category: string]

      Returns ChainablePromiseElement<Element>

settingConstructor$$: ((...args) => ChainablePromiseArray<Element[]>)

Type declaration

    • (...args): ChainablePromiseArray<Element[]>
    • Parameters

      • Rest ...args: [title: string, category: string]

      Returns ChainablePromiseArray<Element[]>

settingDesctiption$: ChainablePromiseElement<Element>
settingDesctiption$$: ChainablePromiseArray<Element[]>
settingsEditor$: ChainablePromiseElement<Element>
settingsEditor$$: ChainablePromiseArray<Element[]>
tab$: ChainablePromiseElement<Element>
tab$$: ChainablePromiseArray<Element[]>
tabLabel$: ChainablePromiseElement<Element>
tabLabel$$: ChainablePromiseArray<Element[]>
tabSeparator$: ChainablePromiseElement<Element>
tabSeparator$$: ChainablePromiseArray<Element[]>
tabTitle$: ChainablePromiseElement<Element>
tabTitle$$: ChainablePromiseArray<Element[]>
tabs$: ChainablePromiseElement<Element>
tabs$$: ChainablePromiseArray<Element[]>
textSetting$: ChainablePromiseElement<Element>
textSetting$$: ChainablePromiseArray<Element[]>
title$: ChainablePromiseElement<Element>
title$$: ChainablePromiseArray<Element[]>
webView$: ChainablePromiseElement<Element>
webView$$: ChainablePromiseArray<Element[]>

Accessors

  • get elem(): ChainablePromiseElement<Element>
  • Base element of given page object

    Returns ChainablePromiseElement<Element>

  • get parent(): ChainablePromiseElement<Element>
  • Parent element of given page object

    Returns ChainablePromiseElement<Element>

Methods

  • Search for a setting with a particular title and category. Returns an appropriate Setting object if the label is found, undefined otherwise.

    If your setting has nested categories (i.e example.general.test), pass in each category as a separate string.

    Parameters

    • title: string

      title of the setting

    • Rest ...categories: string[]

      category of the setting

    Returns Promise<Setting>

    Promise resolving to a Setting object if found, undefined otherwise

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

    thenable self reference

  • Switch between settings perspectives Works only if your vscode instance has both user and workspace settings available

    Parameters

    • perspective: "User" | "Workspace"

      User or Workspace

    Returns Promise<void>

    Promise that resolves when the appropriate button is clicked

Generated using TypeDoc