interface ITfvcApi {
    baseUrl: string;
    http: HttpClient;
    rest: RestClient;
    userAgent: string;
    vsoClient: VsoClient;
    createAcceptHeader(type: string, apiVersion?: string): string;
    createChangeset(
        changeset: TfvcChangeset,
        project?: string,
    ): Promise<TfvcChangesetRef>;
    createRequestOptions(type: string, apiVersion?: string): IRequestOptions;
    formatResponse(
        data: any,
        responseTypeMetadata: any,
        isCollection: boolean,
    ): any;
    getBatchedChangesets(
        changesetsRequestData: TfvcChangesetsRequestData,
    ): Promise<TfvcChangesetRef[]>;
    getBranch(
        path: string,
        project?: string,
        includeParent?: boolean,
        includeChildren?: boolean,
    ): Promise<TfvcBranch>;
    getBranches(
        project?: string,
        includeParent?: boolean,
        includeChildren?: boolean,
        includeDeleted?: boolean,
        includeLinks?: boolean,
    ): Promise<TfvcBranch[]>;
    getBranchRefs(
        scopePath: string,
        project?: string,
        includeDeleted?: boolean,
        includeLinks?: boolean,
    ): Promise<TfvcBranchRef[]>;
    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>;
    getChangesetChanges(
        id?: number,
        skip?: number,
        top?: number,
    ): Promise<PagedList<TfvcChange>>;
    getChangesets(
        project?: string,
        maxCommentLength?: number,
        skip?: number,
        top?: number,
        orderby?: string,
        searchCriteria?: TfvcChangesetSearchCriteria,
    ): Promise<TfvcChangesetRef[]>;
    getChangesetWorkItems(id?: number): Promise<AssociatedWorkItem[]>;
    getItem(
        path: string,
        project?: string,
        fileName?: string,
        download?: boolean,
        scopePath?: string,
        recursionLevel?: VersionControlRecursionType,
        versionDescriptor?: TfvcVersionDescriptor,
        includeContent?: boolean,
    ): Promise<TfvcItem>;
    getItemContent(
        path: string,
        project?: string,
        fileName?: string,
        download?: boolean,
        scopePath?: string,
        recursionLevel?: VersionControlRecursionType,
        versionDescriptor?: TfvcVersionDescriptor,
        includeContent?: boolean,
    ): Promise<ReadableStream>;
    getItems(
        project?: string,
        scopePath?: string,
        recursionLevel?: VersionControlRecursionType,
        includeLinks?: boolean,
        versionDescriptor?: TfvcVersionDescriptor,
    ): Promise<TfvcItem[]>;
    getItemsBatch(
        itemRequestData: TfvcItemRequestData,
        project?: string,
    ): Promise<TfvcItem[][]>;
    getItemsBatchZip(
        itemRequestData: TfvcItemRequestData,
        project?: string,
    ): Promise<ReadableStream>;
    getItemText(
        path: string,
        project?: string,
        fileName?: string,
        download?: boolean,
        scopePath?: string,
        recursionLevel?: VersionControlRecursionType,
        versionDescriptor?: TfvcVersionDescriptor,
        includeContent?: boolean,
    ): Promise<ReadableStream>;
    getItemZip(
        path: string,
        project?: string,
        fileName?: string,
        download?: boolean,
        scopePath?: string,
        recursionLevel?: VersionControlRecursionType,
        versionDescriptor?: TfvcVersionDescriptor,
        includeContent?: boolean,
    ): Promise<ReadableStream>;
    getLabel(
        labelId: string,
        requestData: TfvcLabelRequestData,
        project?: string,
    ): Promise<TfvcLabel>;
    getLabelItems(
        labelId: string,
        top?: number,
        skip?: number,
    ): Promise<TfvcItem[]>;
    getLabels(
        requestData: TfvcLabelRequestData,
        project?: string,
        top?: number,
        skip?: number,
    ): Promise<TfvcLabelRef[]>;
    getShelveset(
        shelvesetId: string,
        requestData?: TfvcShelvesetRequestData,
    ): Promise<TfvcShelveset>;
    getShelvesetChanges(
        shelvesetId: string,
        top?: number,
        skip?: number,
    ): Promise<TfvcChange[]>;
    getShelvesets(
        requestData?: TfvcShelvesetRequestData,
        top?: number,
        skip?: number,
    ): Promise<TfvcShelvesetRef[]>;
    getShelvesetWorkItems(shelvesetId: string): Promise<AssociatedWorkItem[]>;
    getTfvcStatistics(
        project?: string,
        scopePath?: string,
    ): Promise<TfvcStatistics>;
}

Hierarchy (View Summary)

Implemented by

Properties

baseUrl: string
http: HttpClient
rest: RestClient
userAgent: string
vsoClient: VsoClient

Methods

  • Parameters

    • path: string
    • Optionalproject: string
    • OptionalincludeParent: boolean
    • OptionalincludeChildren: boolean

    Returns Promise<TfvcBranch>

  • Parameters

    • Optionalproject: string
    • OptionalincludeParent: boolean
    • OptionalincludeChildren: boolean
    • OptionalincludeDeleted: boolean
    • OptionalincludeLinks: boolean

    Returns Promise<TfvcBranch[]>

  • Parameters

    • id: number
    • Optionalproject: string
    • OptionalmaxChangeCount: number
    • OptionalincludeDetails: boolean
    • OptionalincludeWorkItems: boolean
    • OptionalmaxCommentLength: number
    • OptionalincludeSourceRename: boolean
    • Optionalskip: number
    • Optionaltop: number
    • Optionalorderby: string
    • OptionalsearchCriteria: TfvcChangesetSearchCriteria

    Returns Promise<TfvcChangeset>