circleci-api/dist/types/src/api/metadata.d.ts

A Node and Browser client for the CircleCI API, written in TypeScript.

import { GitInfo, TestMetadataResponse, CircleOptions } from "../types";
/**
 * Provides test metadata for a build
 *
 * @see https://circleci.com/docs/api/v1-reference/#test-metadata
 * @example GET : https://circleci.com/api/v1.1/project/:vcs-type/:username/:project/:build_num/tests
 *
 * @param token CircleCI API token
 * @param buildNumber Build number to get metadata for
 * @param circleHost Provide custom url for CircleCI
 * @param vcs Git information for project
 * @returns metadata for tests
 */
export declare function getTestMetadata(token: string, buildNumber: number, { circleHost, ...vcs }: GitInfo & CircleOptions): Promise<TestMetadataResponse>;