Class SettingsEditor

Page object representing the internal VSCode settings editor

Hierarchy (view full)

Constructors

constructor

Properties

action$ action$$ actionContainer$ actionContainer$$ actionItem$ actionItem$$ actions$ actions$$ activeTab$ activeTab$$ breakPoint$ breakPoint$$ checkboxChecked$ checkboxChecked$$ checkboxSetting$ checkboxSetting$$ closeTab$ closeTab$$ comboOption$ comboOption$$ comboSetting$ comboSetting$$ dataUri$ dataUri$$ debugHint$ debugHint$$ diffEditor$ diffEditor$$ editorContainer$ editorContainer$$ editorGroup$ editorGroup$$ elem$ elem$$ findWidget$ findWidget$$ formatDoc$ formatDoc$$ header$ header$$ inputArea$ inputArea$$ itemCount$ itemCount$$ itemRow$ itemRow$$ lineNumber$ lineNumber$$ lineOverlay$ lineOverlay$$ linkButton$ linkButton$$ marginArea$ marginArea$$ modifiedEditor$ modifiedEditor$$ originalEditor$ originalEditor$$ selection$ selection$$ settingConstructor$ settingConstructor$$ settingDesctiption$ settingDesctiption$$ settingsEditor$ settingsEditor$$ tab$ tab$$ tabLabel$ tabLabel$$ tabSeparator$ tabSeparator$$ tabTitle$ tabTitle$$ tabs$ tabs$$ textSetting$ textSetting$$ title$ title$$ view webView$ webView$$

Accessors

elem locators parent

Methods

findSetting getTab getTitle openContextMenu poll switchToPerspective wait

Constructors

constructor

Properties

action$

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

Type declaration

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

    • Parameters

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

      Returns ChainablePromiseElement<Element>

action$$

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

Type declaration

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

    • Parameters

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

      Returns ChainablePromiseArray<Element[]>

actionContainer$

actionContainer$: ChainablePromiseElement<Element>

actionContainer$$

actionContainer$$: ChainablePromiseArray<Element[]>

actionItem$

actionItem$: ChainablePromiseElement<Element>

actionItem$$

actionItem$$: ChainablePromiseArray<Element[]>

actions$

actions$: ChainablePromiseElement<Element>

actions$$

actions$$: ChainablePromiseArray<Element[]>

activeTab$

activeTab$: ChainablePromiseElement<Element>

activeTab$$

activeTab$$: ChainablePromiseArray<Element[]>

breakPoint$

breakPoint$: ChainablePromiseElement<Element>

breakPoint$$

breakPoint$$: ChainablePromiseArray<Element[]>

checkboxChecked$

checkboxChecked$: ChainablePromiseElement<Element>

checkboxChecked$$

checkboxChecked$$: ChainablePromiseArray<Element[]>

checkboxSetting$

checkboxSetting$: ChainablePromiseElement<Element>

checkboxSetting$$

checkboxSetting$$: ChainablePromiseArray<Element[]>

closeTab$

closeTab$: ChainablePromiseElement<Element>

closeTab$$

closeTab$$: ChainablePromiseArray<Element[]>

comboOption$

comboOption$: ChainablePromiseElement<Element>

comboOption$$

comboOption$$: ChainablePromiseArray<Element[]>

comboSetting$

comboSetting$: ChainablePromiseElement<Element>

comboSetting$$

comboSetting$$: ChainablePromiseArray<Element[]>

dataUri$

dataUri$: ChainablePromiseElement<Element>

dataUri$$

dataUri$$: ChainablePromiseArray<Element[]>

debugHint$

debugHint$: ChainablePromiseElement<Element>

debugHint$$

debugHint$$: ChainablePromiseArray<Element[]>

diffEditor$

diffEditor$: ChainablePromiseElement<Element>

diffEditor$$

diffEditor$$: ChainablePromiseArray<Element[]>

editorContainer$

editorContainer$: ChainablePromiseElement<Element>

editorContainer$$

editorContainer$$: ChainablePromiseArray<Element[]>

editorGroup$

editorGroup$: ChainablePromiseElement<Element>

editorGroup$$

editorGroup$$: ChainablePromiseArray<Element[]>

elem$

elem$: ChainablePromiseElement<Element>

elem$$

elem$$: ChainablePromiseArray<Element[]>

findWidget$

findWidget$: ChainablePromiseElement<Element>

findWidget$$

findWidget$$: ChainablePromiseArray<Element[]>

formatDoc$

formatDoc$: ChainablePromiseElement<Element>

formatDoc$$

formatDoc$$: ChainablePromiseArray<Element[]>

header$

header$: ChainablePromiseElement<Element>

header$$

header$$: ChainablePromiseArray<Element[]>

inputArea$

inputArea$: ChainablePromiseElement<Element>

inputArea$$

inputArea$$: ChainablePromiseArray<Element[]>

itemCount$

itemCount$: ChainablePromiseElement<Element>

itemCount$$

itemCount$$: ChainablePromiseArray<Element[]>

itemRow$

itemRow$: ChainablePromiseElement<Element>

itemRow$$

itemRow$$: ChainablePromiseArray<Element[]>

lineNumber$

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

Type declaration

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

    • Parameters

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

      Returns ChainablePromiseElement<Element>

lineNumber$$

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

Type declaration

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

    • Parameters

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

      Returns ChainablePromiseArray<Element[]>

lineOverlay$

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

Type declaration

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

    • Parameters

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

      Returns ChainablePromiseElement<Element>

lineOverlay$$

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

Type declaration

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

    • Parameters

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

      Returns ChainablePromiseArray<Element[]>

linkButton$

linkButton$: ChainablePromiseElement<Element>

linkButton$$

linkButton$$: ChainablePromiseArray<Element[]>

marginArea$

marginArea$: ChainablePromiseElement<Element>

marginArea$$

marginArea$$: ChainablePromiseArray<Element[]>

modifiedEditor$

modifiedEditor$: ChainablePromiseElement<Element>

modifiedEditor$$

modifiedEditor$$: ChainablePromiseArray<Element[]>

originalEditor$

originalEditor$: ChainablePromiseElement<Element>

originalEditor$$

originalEditor$$: ChainablePromiseArray<Element[]>

selection$

selection$: ChainablePromiseElement<Element>

selection$$

selection$$: ChainablePromiseArray<Element[]>

settingConstructor$

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

Type declaration

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

    • Parameters

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

      Returns ChainablePromiseElement<Element>

settingConstructor$$

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

Type declaration

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

    • Parameters

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

      Returns ChainablePromiseArray<Element[]>

settingDesctiption$

settingDesctiption$: ChainablePromiseElement<Element>

settingDesctiption$$

settingDesctiption$$: ChainablePromiseArray<Element[]>

settingsEditor$

settingsEditor$: ChainablePromiseElement<Element>

settingsEditor$$

settingsEditor$$: ChainablePromiseArray<Element[]>

tab$

tab$: ChainablePromiseElement<Element>

tab$$

tab$$: ChainablePromiseArray<Element[]>

tabLabel$

tabLabel$: ChainablePromiseElement<Element>

tabLabel$$

tabLabel$$: ChainablePromiseArray<Element[]>

tabSeparator$

tabSeparator$: ChainablePromiseElement<Element>

tabSeparator$$

tabSeparator$$: ChainablePromiseArray<Element[]>

tabTitle$

tabTitle$: ChainablePromiseElement<Element>

tabTitle$$

tabTitle$$: ChainablePromiseArray<Element[]>

tabs$

tabs$: ChainablePromiseElement<Element>

tabs$$

tabs$$: ChainablePromiseArray<Element[]>

textSetting$

textSetting$: ChainablePromiseElement<Element>

textSetting$$

textSetting$$: ChainablePromiseArray<Element[]>

title$

title$: ChainablePromiseElement<Element>

title$$

title$$: ChainablePromiseArray<Element[]>

view

view: EditorView | EditorGroup

webView$

webView$: ChainablePromiseElement<Element>

webView$$

webView$$: ChainablePromiseArray<Element[]>

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

findSetting

  • findSetting(title, ...categories): Promise<Setting>

  • 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

getTab

getTitle

openContextMenu

poll

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

  • 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

switchToPerspective

  • switchToPerspective(perspective): Promise<void>

  • 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

wait

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc