angles-javascript-client
Version:
This is the javascript client for the Angles Dashboard. It allows you to store your test results.
29 lines (28 loc) • 1.77 kB
TypeScript
import { AxiosResponse, AxiosInstance } from 'axios';
import { BaseRequests } from './BaseRequests';
import { Screenshot } from '../models/Screenshot';
import { StoreScreenshot } from '../models/requests/StoreScreenshot';
import { ImageCompareResponse } from '../models/response/ImageCompareResponse';
import { DefaultResponse } from "../models/response/DefaultResponse";
export declare class ScreenshotRequests extends BaseRequests {
constructor(axiosInstance: AxiosInstance);
saveScreenshot(storeScreenshot: StoreScreenshot): Promise<Screenshot>;
/**
* Retrieves the screenshots for a specified build
* @param {string} buildId
* @param {number} [limit=100]
*/
getScreenshotsForBuild(buildId: string, limit: number): Promise<Screenshot[]>;
getScreenshots(screenshotIds: string[]): Promise<Screenshot[]>;
getScreenshotViews(view: string, limit: number): Promise<string[]>;
getScreenshotTags(tag: string, limit: number): Promise<string[]>;
getScreenshotHistoryByView(view: string, platformId: string, limit: number, offset: number): Promise<Screenshot[]>;
getScreenshotsGroupedByPlatform(view: string, numberOfDays: number): Promise<Screenshot[]>;
getScreenshotsGroupedByTag(tag: string, numberOfDays: number): Promise<Screenshot[]>;
getScreenshot(screenshotId: string): Promise<Screenshot>;
deleteScreenshot(screenshotId: string): Promise<DefaultResponse>;
getScreenshotImage(screenshotId: string): Promise<AxiosResponse>;
getDynamicBaselineImage(screenshotId: string, numberOfImagesToCompare: number): Promise<Screenshot>;
getBaselineCompareImage(screenshotId: string, cache: boolean): Promise<AxiosResponse>;
getBaselineCompare(screenshotId: string): Promise<ImageCompareResponse>;
}