Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RefsApi

Hierarchy

  • RefsApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new RefsApi(basePath?: string): RefsApi

Properties

Protected basePath

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

defaultHeaders

defaultHeaders: any

Methods

getRefs

  • getRefs(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<ArrayWrapper<GitRef>>

  • Queries the provided repository for its refs and returns them.

    Parameters

    • params: object
      • Optional $Top?: number
      • apiVersion: string
      • Optional continuationToken?: string
      • Optional filter?: string
      • Optional filterContains?: string
      • Optional includeLinks?: boolean
      • Optional includeMyBranches?: boolean
      • Optional includeStatuses?: boolean
      • Optional latestStatusesOnly?: boolean
      • organization: string
      • Optional peelTags?: boolean
      • project: string
      • repositoryId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<GitRef>>

updateRef

  • updateRef(params: object, extraQueryParams?: any, extraFetchParams?: any): Promise<GitRef>

  • Lock or Unlock a branch.

    Parameters

    • params: object
      • apiVersion: string
      • body: GitRefUpdate
      • filter: string
      • organization: string
      • project: string
      • Optional projectId?: string
      • repositoryId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<GitRef>

updateRefs

  • Creating, updating, or deleting refs(branches). Updating a ref means making it point at a different commit than it used to. You must specify both the old and new commit to avoid race conditions.

    Parameters

    • params: object
      • apiVersion: string
      • body: Array<GitRefUpdate>
      • organization: string
      • project: string
      • Optional projectId?: string
      • repositoryId: string
    • Optional extraQueryParams: any
    • Optional extraFetchParams: any

    Returns Promise<ArrayWrapper<GitRefUpdateResult>>

Generated using TypeDoc