Page object representing a repository in the source control view Maps roughly to a view section of the source control view

Hierarchy (view full)

Constructors

Properties

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

Type declaration

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

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

      Returns ChainablePromiseElement<Element>

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

Type declaration

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

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

      Returns ChainablePromiseArray<Element[]>

changeCount$: ChainablePromiseElement<Element>
changeCount$$: ChainablePromiseArray<Element[]>
changeDesc$: ChainablePromiseElement<Element>
changeDesc$$: ChainablePromiseArray<Element[]>
changeItem$: ChainablePromiseElement<Element>
changeItem$$: ChainablePromiseArray<Element[]>
changeLabel$: ChainablePromiseElement<Element>
changeLabel$$: ChainablePromiseArray<Element[]>
changeName$: ChainablePromiseElement<Element>
changeName$$: ChainablePromiseArray<Element[]>
changes$: ChainablePromiseElement<Element>
changes$$: ChainablePromiseArray<Element[]>
expand$: ChainablePromiseElement<Element>
expand$$: ChainablePromiseArray<Element[]>
initButton$: ChainablePromiseElement<Element>
initButton$$: ChainablePromiseArray<Element[]>
inputField$: ChainablePromiseElement<Element>
inputField$$: ChainablePromiseArray<Element[]>
itemIndex$: ((...args) => ChainablePromiseElement<Element>)

Type declaration

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

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

      Returns ChainablePromiseElement<Element>

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

Type declaration

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

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

      Returns ChainablePromiseArray<Element[]>

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

Type declaration

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

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

      Returns ChainablePromiseElement<Element>

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

Type declaration

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

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

      Returns ChainablePromiseArray<Element[]>

more$: ChainablePromiseElement<Element>
more$$: ChainablePromiseArray<Element[]>
multiMore$: ChainablePromiseElement<Element>
multiMore$$: ChainablePromiseArray<Element[]>
multiProviderItem$: ChainablePromiseElement<Element>
multiProviderItem$$: ChainablePromiseArray<Element[]>
multiScmProvider$: ChainablePromiseElement<Element>
multiScmProvider$$: ChainablePromiseArray<Element[]>
providerHeader$: ChainablePromiseElement<Element>
providerHeader$$: ChainablePromiseArray<Element[]>
providerRelative$: ChainablePromiseElement<Element>
providerRelative$$: ChainablePromiseArray<Element[]>
providerTitle$: ChainablePromiseElement<Element>
providerTitle$$: ChainablePromiseArray<Element[]>
providerType$: ChainablePromiseElement<Element>
providerType$$: ChainablePromiseArray<Element[]>
resource$: ChainablePromiseElement<Element>
resource$$: ChainablePromiseArray<Element[]>
singleScmProvider$: ChainablePromiseElement<Element>
singleScmProvider$$: ChainablePromiseArray<Element[]>
stagedChanges$: ChainablePromiseElement<Element>
stagedChanges$$: ChainablePromiseArray<Element[]>
view: ScmView

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

  • Fill in the message field and send ctrl/cmd + enter to commit the changes

    Parameters

    • message: string

      the commit message to use

    Returns Promise<void>

    promise resolving once the keypresses are sent

  • Get the number of changes for a given section

    Parameters

    • staged: boolean = false

      when true, counts the staged changes, unstaged otherwise

    Returns Promise<number>

    promise resolving to number of changes in the given subsection

  • Get page objects for all tree items representing individual changes

    Parameters

    • staged: boolean = false

      when true, finds staged changes otherwise finds unstaged changes

    Returns Promise<ScmChange[]>

    promise resolving to ScmChange object array

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

    thenable self reference

  • Find an action button for the SCM provider by title and click it. (e.g 'Commit')

    Parameters

    • title: string

      Title of the action button to click

    Returns Promise<boolean>

    true if the given action could be performed, false if the button doesn't exist

Generated using TypeDoc