Class TfvcApi

constructor

• new TfvcApi(
      baseUrl: string,
      handlers: IRequestHandler[],
      options?: IRequestOptions,
  ): TfvcApi

  Parameters

  • baseUrl: string
  • handlers: IRequestHandler[]
  • Optionaloptions: IRequestOptions

  Returns TfvcApi

Static ReadonlyRESOURCE_AREA_ID

createChangeset

• createChangeset(
      changeset: TfvcChangeset,
      project?: string,
  ): Promise<TfvcChangesetRef>

  Create a new changeset.

  Parameters

  • changeset: TfvcChangeset
  • Optionalproject: string

    Project ID or project name

  Returns Promise<TfvcChangesetRef>

getBatchedChangesets

• getBatchedChangesets(
      changesetsRequestData: TfvcChangesetsRequestData,
  ): Promise<TfvcChangesetRef[]>

  Returns changesets for a given list of changeset Ids.

  Parameters

  • changesetsRequestData: TfvcChangesetsRequestData

    List of changeset IDs.

  Returns Promise<TfvcChangesetRef[]>

getBranch

• getBranch(
      path: string,
      project?: string,
      includeParent?: boolean,
      includeChildren?: boolean,
  ): Promise<TfvcBranch>

  Get a single branch hierarchy at the given path with parents or children as specified.

  Parameters

  • path: string

    Full path to the branch. Default: $/ Examples: $/, $/MyProject, $/MyProject/SomeFolder.
  • Optionalproject: string

    Project ID or project name
  • OptionalincludeParent: boolean

    Return the parent branch, if there is one. Default: False
  • OptionalincludeChildren: boolean

    Return child branches, if there are any. Default: False

  Returns Promise<TfvcBranch>

getBranches

• getBranches(
      project?: string,
      includeParent?: boolean,
      includeChildren?: boolean,
      includeDeleted?: boolean,
      includeLinks?: boolean,
  ): Promise<TfvcBranch[]>

  Get a collection of branch roots -- first-level children, branches with no parents.

  Parameters

  • Optionalproject: string

    Project ID or project name
  • OptionalincludeParent: boolean

    Return the parent branch, if there is one. Default: False
  • OptionalincludeChildren: boolean

    Return the child branches for each root branch. Default: False
  • OptionalincludeDeleted: boolean

    Return deleted branches. Default: False
  • OptionalincludeLinks: boolean

    Return links. Default: False

  Returns Promise<TfvcBranch[]>

getBranchRefs

• getBranchRefs(
      scopePath: string,
      project?: string,
      includeDeleted?: boolean,
      includeLinks?: boolean,
  ): Promise<TfvcBranchRef[]>

  Get branch hierarchies below the specified scopePath

  Parameters

  • scopePath: string

    Full path to the branch. Default: $/ Examples: $/, $/MyProject, $/MyProject/SomeFolder.
  • Optionalproject: string

    Project ID or project name
  • OptionalincludeDeleted: boolean

    Return deleted branches. Default: False
  • OptionalincludeLinks: boolean

    Return links. Default: False

  Returns Promise<TfvcBranchRef[]>

getChangeset

• getChangeset(
      id: number,
      project?: string,
      maxChangeCount?: number,
      includeDetails?: boolean,
      includeWorkItems?: boolean,
      maxCommentLength?: number,
      includeSourceRename?: boolean,
      skip?: number,
      top?: number,
      orderby?: string,
      searchCriteria?: TfvcChangesetSearchCriteria,
  ): Promise<TfvcChangeset>

  Retrieve a Tfvc Changeset

  Parameters

  • id: number

    Changeset Id to retrieve.
  • Optionalproject: string

    Project ID or project name
  • OptionalmaxChangeCount: number

    Number of changes to return (maximum 100 changes) Default: 0
  • OptionalincludeDetails: boolean

    Include policy details and check-in notes in the response. Default: false
  • OptionalincludeWorkItems: boolean

    Include workitems. Default: false
  • OptionalmaxCommentLength: number

    Include details about associated work items in the response. Default: null
  • OptionalincludeSourceRename: boolean

    Include renames. Default: false
  • Optionalskip: number

    Number of results to skip. Default: null
  • Optionaltop: number

    The maximum number of results to return. Default: null
  • Optionalorderby: string

    Results are sorted by ID in descending order by default. Use id asc to sort by ID in ascending order.
  • OptionalsearchCriteria: TfvcChangesetSearchCriteria

    Following criteria available (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Default: null

  Returns Promise<TfvcChangeset>

getChangesetChanges

• getChangesetChanges(
      id?: number,
      skip?: number,
      top?: number,
  ): Promise<PagedList<TfvcChange>>

  Retrieve Tfvc changes for a given changeset.

  Parameters

  • Optionalid: number

    ID of the changeset. Default: null
  • Optionalskip: number

    Number of results to skip. Default: null
  • Optionaltop: number

    The maximum number of results to return. Default: null

  Returns Promise<PagedList<TfvcChange>>

getChangesets

• getChangesets(
      project?: string,
      maxCommentLength?: number,
      skip?: number,
      top?: number,
      orderby?: string,
      searchCriteria?: TfvcChangesetSearchCriteria,
  ): Promise<TfvcChangesetRef[]>

  Retrieve Tfvc Changesets

  Parameters

  • Optionalproject: string

    Project ID or project name
  • OptionalmaxCommentLength: number

    Include details about associated work items in the response. Default: null
  • Optionalskip: number

    Number of results to skip. Default: null
  • Optionaltop: number

    The maximum number of results to return. Default: null
  • Optionalorderby: string

    Results are sorted by ID in descending order by default. Use id asc to sort by ID in ascending order.
  • OptionalsearchCriteria: TfvcChangesetSearchCriteria

    Following criteria available (.itemPath, .version, .versionType, .versionOption, .author, .fromId, .toId, .fromDate, .toDate) Default: null

  Returns Promise<TfvcChangesetRef[]>

getChangesetWorkItems

• getChangesetWorkItems(id?: number): Promise<AssociatedWorkItem[]>

  Retrieves the work items associated with a particular changeset.

  Parameters

  • Optionalid: number

    ID of the changeset.

  Returns Promise<AssociatedWorkItem[]>

getItem

• getItem(
      path: string,
      project?: string,
      fileName?: string,
      download?: boolean,
      scopePath?: string,
      recursionLevel?: VersionControlRecursionType,
      versionDescriptor?: TfvcVersionDescriptor,
      includeContent?: boolean,
  ): Promise<TfvcItem>

  Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

  Parameters

  • path: string

    Version control path of an individual item to return.
  • Optionalproject: string

    Project ID or project name
  • OptionalfileName: string

    file name of item returned.
  • Optionaldownload: boolean

    If true, create a downloadable attachment.
  • OptionalscopePath: string

    Version control path of a folder to return multiple items.
  • OptionalrecursionLevel: VersionControlRecursionType

    None (just the item), or OneLevel (contents of a folder).
  • OptionalversionDescriptor: TfvcVersionDescriptor

    Version descriptor. Default is null.
  • OptionalincludeContent: boolean

    Set to true to include item content when requesting json. Default is false.

  Returns Promise<TfvcItem>

getItemContent

• getItemContent(
      path: string,
      project?: string,
      fileName?: string,
      download?: boolean,
      scopePath?: string,
      recursionLevel?: VersionControlRecursionType,
      versionDescriptor?: TfvcVersionDescriptor,
      includeContent?: boolean,
  ): Promise<ReadableStream>

  Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

  Parameters

  • path: string

    Version control path of an individual item to return.
  • Optionalproject: string

    Project ID or project name
  • OptionalfileName: string

    file name of item returned.
  • Optionaldownload: boolean

    If true, create a downloadable attachment.
  • OptionalscopePath: string

    Version control path of a folder to return multiple items.
  • OptionalrecursionLevel: VersionControlRecursionType

    None (just the item), or OneLevel (contents of a folder).
  • OptionalversionDescriptor: TfvcVersionDescriptor

    Version descriptor. Default is null.
  • OptionalincludeContent: boolean

    Set to true to include item content when requesting json. Default is false.

  Returns Promise<ReadableStream>

getItems

• getItems(
      project?: string,
      scopePath?: string,
      recursionLevel?: VersionControlRecursionType,
      includeLinks?: boolean,
      versionDescriptor?: TfvcVersionDescriptor,
  ): Promise<TfvcItem[]>

  Get a list of Tfvc items

  Parameters

  • Optionalproject: string

    Project ID or project name
  • OptionalscopePath: string

    Version control path of a folder to return multiple items.
  • OptionalrecursionLevel: VersionControlRecursionType

    None (just the item), or OneLevel (contents of a folder).
  • OptionalincludeLinks: boolean

    True to include links.
  • OptionalversionDescriptor: TfvcVersionDescriptor

  Returns Promise<TfvcItem[]>

getItemsBatch

• getItemsBatch(
      itemRequestData: TfvcItemRequestData,
      project?: string,
  ): Promise<TfvcItem[][]>

  Post for retrieving a set of items given a list of paths or a long path. Allows for specifying the recursionLevel and version descriptors for each path.

  Parameters

  • itemRequestData: TfvcItemRequestData
  • Optionalproject: string

    Project ID or project name

  Returns Promise<TfvcItem[][]>

getItemsBatchZip

• getItemsBatchZip(
      itemRequestData: TfvcItemRequestData,
      project?: string,
  ): Promise<ReadableStream>

  Post for retrieving a set of items given a list of paths or a long path. Allows for specifying the recursionLevel and version descriptors for each path.

  Parameters

  • itemRequestData: TfvcItemRequestData
  • Optionalproject: string

    Project ID or project name

  Returns Promise<ReadableStream>

getItemText

• getItemText(
      path: string,
      project?: string,
      fileName?: string,
      download?: boolean,
      scopePath?: string,
      recursionLevel?: VersionControlRecursionType,
      versionDescriptor?: TfvcVersionDescriptor,
      includeContent?: boolean,
  ): Promise<ReadableStream>

  Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

  Parameters

  • path: string

    Version control path of an individual item to return.
  • Optionalproject: string

    Project ID or project name
  • OptionalfileName: string

    file name of item returned.
  • Optionaldownload: boolean

    If true, create a downloadable attachment.
  • OptionalscopePath: string

    Version control path of a folder to return multiple items.
  • OptionalrecursionLevel: VersionControlRecursionType

    None (just the item), or OneLevel (contents of a folder).
  • OptionalversionDescriptor: TfvcVersionDescriptor

    Version descriptor. Default is null.
  • OptionalincludeContent: boolean

    Set to true to include item content when requesting json. Default is false.

  Returns Promise<ReadableStream>

getItemZip

• getItemZip(
      path: string,
      project?: string,
      fileName?: string,
      download?: boolean,
      scopePath?: string,
      recursionLevel?: VersionControlRecursionType,
      versionDescriptor?: TfvcVersionDescriptor,
      includeContent?: boolean,
  ): Promise<ReadableStream>

  Get Item Metadata and/or Content for a single item. The download parameter is to indicate whether the content should be available as a download or just sent as a stream in the response. Doesn't apply to zipped content which is always returned as a download.

  Parameters

  • path: string

    Version control path of an individual item to return.
  • Optionalproject: string

    Project ID or project name
  • OptionalfileName: string

    file name of item returned.
  • Optionaldownload: boolean

    If true, create a downloadable attachment.
  • OptionalscopePath: string

    Version control path of a folder to return multiple items.
  • OptionalrecursionLevel: VersionControlRecursionType

    None (just the item), or OneLevel (contents of a folder).
  • OptionalversionDescriptor: TfvcVersionDescriptor

    Version descriptor. Default is null.
  • OptionalincludeContent: boolean

    Set to true to include item content when requesting json. Default is false.

  Returns Promise<ReadableStream>

getLabel

• getLabel(
      labelId: string,
      requestData: TfvcLabelRequestData,
      project?: string,
  ): Promise<TfvcLabel>

  Get a single deep label.

  Parameters

  • labelId: string

    Unique identifier of label
  • requestData: TfvcLabelRequestData

    maxItemCount
  • Optionalproject: string

    Project ID or project name

  Returns Promise<TfvcLabel>

getLabelItems

• getLabelItems(labelId: string, top?: number, skip?: number): Promise<TfvcItem[]>

  Get items under a label.

  Parameters

  • labelId: string

    Unique identifier of label
  • Optionaltop: number

    Max number of items to return
  • Optionalskip: number

    Number of items to skip

  Returns Promise<TfvcItem[]>

getLabels

• getLabels(
      requestData: TfvcLabelRequestData,
      project?: string,
      top?: number,
      skip?: number,
  ): Promise<TfvcLabelRef[]>

  Get a collection of shallow label references.

  Parameters

  • requestData: TfvcLabelRequestData

    labelScope, name, owner, and itemLabelFilter
  • Optionalproject: string

    Project ID or project name
  • Optionaltop: number

    Max number of labels to return, defaults to 100 when undefined
  • Optionalskip: number

    Number of labels to skip

  Returns Promise<TfvcLabelRef[]>

getShelveset

• getShelveset(
      shelvesetId: string,
      requestData?: TfvcShelvesetRequestData,
  ): Promise<TfvcShelveset>

  Get a single deep shelveset.

  Parameters

  • shelvesetId: string

    Shelveset's unique ID
  • OptionalrequestData: TfvcShelvesetRequestData

    includeDetails, includeWorkItems, maxChangeCount, and maxCommentLength

  Returns Promise<TfvcShelveset>

getShelvesetChanges

• getShelvesetChanges(
      shelvesetId: string,
      top?: number,
      skip?: number,
  ): Promise<TfvcChange[]>

  Get changes included in a shelveset.

  Parameters

  • shelvesetId: string

    Shelveset's unique ID
  • Optionaltop: number

    Max number of changes to return
  • Optionalskip: number

    Number of changes to skip

  Returns Promise<TfvcChange[]>

getShelvesets

• getShelvesets(
      requestData?: TfvcShelvesetRequestData,
      top?: number,
      skip?: number,
  ): Promise<TfvcShelvesetRef[]>

  Return a collection of shallow shelveset references.

  Parameters

  • OptionalrequestData: TfvcShelvesetRequestData

    name, owner, and maxCommentLength
  • Optionaltop: number

    Max number of shelvesets to return
  • Optionalskip: number

    Number of shelvesets to skip

  Returns Promise<TfvcShelvesetRef[]>

getShelvesetWorkItems

• getShelvesetWorkItems(shelvesetId: string): Promise<AssociatedWorkItem[]>

  Get work items associated with a shelveset.

  Parameters

  • shelvesetId: string

    Shelveset's unique ID

  Returns Promise<AssociatedWorkItem[]>

getTfvcStatistics

• getTfvcStatistics(project?: string, scopePath?: string): Promise<TfvcStatistics>

  Provides File Count and Uncompressed Bytes for a Collection/Project at a particular scope for TFVC.

  Parameters

  • Optionalproject: string

    Project ID or project name
  • OptionalscopePath: string

    '$/' for collection, '$/project' for specific project

  Returns Promise<TfvcStatistics>