@argos-ci/core
    Preparing search index...

    Interface UploadParameters

    interface UploadParameters {
        apiBaseUrl?: string;
        branch?: string;
        buildName?: string;
        commit?: string;
        files?: string[];
        ignore?: string[];
        metadata?: {
            testReport?: {
                stats?: { duration?: number; startTime?: string };
                status: "failed" | "passed" | "timedout" | "interrupted";
            };
        };
        mode?: "ci"
        | "monitoring";
        parallel?: false | { index?: number; nonce: string; total: number };
        previewUrl?: { baseUrl: string } | ((url: string) => string);
        prNumber?: number;
        referenceBranch?: string;
        referenceCommit?: string;
        root?: string;
        skipped?: boolean;
        threshold?: number;
        token?: string;
    }
    Index

    Properties

    apiBaseUrl? branch? buildName? commit? files? ignore? metadata? mode? parallel? previewUrl? prNumber? referenceBranch? referenceCommit? root? skipped? threshold? token?

    Properties

    apiBaseUrl?: string

    Base URL of the Argos API.

    "https://api.argos-ci.com/v2/"
    branch?: string

    Git branch name of the build.

    buildName?: string

    Custom build name. Useful when triggering multiple Argos builds for the same commit.

    commit?: string

    Git commit SHA of the build.

    files?: string[]

    Globs that match image file paths to upload.

    ignore?: string[]

    Globs that match image file paths to exclude from upload.

    ["**/*.{png,jpg,jpeg}"]
    metadata?: {
        testReport?: {
            stats?: { duration?: number; startTime?: string };
            status: "failed" | "passed" | "timedout" | "interrupted";
        };
    }

    Additional build metadata.

    mode?: "ci" | "monitoring"

    Build mode to use.

    • "ci": Review the visual changes introduced by a feature branch and prevent regressions.
    • "monitoring": Track visual changes outside the standard CI flow, either on a schedule or before a release.

    https://argos-ci.com/docs/build-modes

    "ci"
    parallel?: false | { index?: number; nonce: string; total: number }

    Parallel test suite configuration.

    Type Declaration

    • false
    • { index?: number; nonce: string; total: number }
      • Optionalindex?: number

        Index of the current job (must start from 1).

      • nonce: string

        Unique build identifier shared across parallel jobs.

      • total: number

        Total number of parallel jobs, set to -1 to finalize manually.

    false
    previewUrl?: { baseUrl: string } | ((url: string) => string)

    Preview URL configuration. Can be a fixed base URL or a function to transform URLs dynamically.

    prNumber?: number

    Pull request number associated with the build.

    referenceBranch?: string

    Branch used as the baseline for screenshot comparison.

    referenceCommit?: string

    Commit SHA used as the baseline for screenshot comparison.

    root?: string

    Root directory used to resolve image paths.

    process.cwd()
    skipped?: boolean

    Mark this build as skipped. No screenshots are uploaded, and the commit status is marked as success.

    threshold?: number

    Diff sensitivity threshold between 0 and 1. Higher values make Argos less sensitive to differences.

    0.5
    token?: string

    Argos repository access token.

    Settings

    Member Visibility

    On This Page

    Properties