@argos-ci/util/dist/browser.d.ts

Set of utilities used across all Argos SDKs.

type ScreenshotMetadata = {
    url?: string;
    previewUrl?: string;
    viewport?: {
        width: number;
        height: number;
    };
    colorScheme?: "light" | "dark";
    mediaType?: "screen" | "print";
    test: {
        id?: string;
        title: string;
        titlePath: string[];
        retries?: number;
        retry?: number;
        repeat?: number;
        location?: {
            file: string;
            line: number;
            column: number;
        };
    } | null;
    browser?: {
        name: string;
        version: string;
    };
    automationLibrary: {
        name: string;
        version: string;
    };
    sdk: {
        name: string;
        version: string;
    };
    transient?: {
        threshold?: number;
        baseName?: string;
    };
};
/**
 * Get metadata path from screenshot path.
 */
declare function getMetadataPath(screenshotPath: string): string;

/**
 * Build a screenshot name from a test name and options.
 */
declare function getScreenshotName(name: string, options?: {
    viewportWidth?: number;
}): string;

/**
 * Validates the threshold value.
 */
declare function validateThreshold(threshold: number): void;

export { type ScreenshotMetadata, getMetadataPath, getScreenshotName, validateThreshold };