Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CommitsApi

Hierarchy

  • CommitsApi

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected basePath

basePath: string = "https://dev.azure.com/"

defaultHeaders

defaultHeaders: any

Methods

getChanges

  • getChanges(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GitCommitChanges>

  • Retrieve changes for a particular commit.

    Parameters

    • params: object
      • apiVersion: string
      • commitId: string
      • organization: string
      • project: string
      • repositoryId: string
      • Optional skip?: number
      • Optional top?: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<GitCommitChanges>

getCommit

  • getCommit(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GitCommit>

  • Retrieve a particular commit.

    Parameters

    • params: object
      • apiVersion: string
      • Optional changeCount?: number
      • commitId: string
      • organization: string
      • project: string
      • repositoryId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<GitCommit>

getCommitsBatch

  • Retrieve git commits for a project matching the search criteria

    Parameters

    • params: object
      • Optional $Skip?: number
      • Optional $Top?: number
      • apiVersion: string
      • body: GitQueryCommitsCriteria
      • Optional includeStatuses?: boolean
      • organization: string
      • project: string
      • repositoryId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<GitCommitRef>>

getPushCommits

  • Retrieve a list of commits associated with a particular push.

    Parameters

    • params: object
      • apiVersion: string
      • Optional includeLinks?: boolean
      • organization: string
      • project: string
      • pushId: number
      • repositoryId: string
      • Optional skip?: number
      • Optional top?: number
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<GitCommitRef>>

Generated using TypeDoc