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;
    threshold?: number;
    token?: string;
}

Properties

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

Properties

OptionalapiBaseUrl

apiBaseUrl?: string

Base URL of Argos API

Default

"https://api.argos-ci.com/v2/"

Optionalbranch

branch?: string

Git branch

OptionalbuildName

buildName?: string

Name of the build used to trigger multiple Argos builds on one commit

Optionalcommit

commit?: string

Git commit

Optionalfiles

files?: string[]

Globs matching image file paths to upload

Optionalignore

ignore?: string[]

Globs matching image file paths to ignore

Default

["**/*.{png,jpg,jpeg}"]

Optionalmetadata

metadata?: {
    testReport?: {
        stats?: { duration?: number; startTime?: string };
        status: "failed" | "passed" | "timedout" | "interrupted";
    };
}

Build metadata.

Optionalmode

mode?: "ci" | "monitoring"

Mode of comparison applied

Default

"ci"

Optionalparallel

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

Parallel test suite mode

Type declaration

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

      The index of the parallel node

    • nonce: string

      Unique build ID for this parallel build

    • total: number

      The number of parallel nodes being ran

OptionalpreviewUrl

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

Preview URL configuration. Accepts a base URL or a function that receives the URL and returns the preview URL.

OptionalprNumber

prNumber?: number

Pull-request number

OptionalreferenceBranch

referenceBranch?: string

Branch used as baseline for screenshot comparison

OptionalreferenceCommit

referenceCommit?: string

Commit used as baseline for screenshot comparison

Optionalroot

root?: string

Root directory to look for image to upload

Default

process.cwd()

Optionalthreshold

threshold?: number

Sensitivity threshold between 0 and 1. The higher the threshold, the less sensitive the diff will be.

Default

0.5

Optionaltoken

token?: string

Argos repository token

Settings

Member Visibility

On This Page

Properties