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

    Interface UploadMediaParameters

    interface UploadMediaParameters {
        apiBaseUrl?: string;
        branch?: string;
        compress?: boolean;
        description?: string;
        files: string[];
        prNumber?: number;
        project?: string;
        state?: MediaState;
        token?: string;
        visibility?: "team" | "public";
    }
    Index
    apiBaseUrl? branch? compress? description? files prNumber? project? state? token? visibility?
    apiBaseUrl?: string

    Base URL of the Argos API.

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

    Branch the media belongs to. Use this when the pull request does not exist yet: the media is staged, and Argos publishes it — and posts the pull request comment — on its own once a pull request opens for that branch.

    compress?: boolean

    Convert images to WebP before uploading, which is what makes a screenshot upload fast. Set to false to upload the file exactly as it is.

    true
    description?: string

    Prose shown under the media in the pull request comment.

    files: string[]

    Paths of the files to upload.

    prNumber?: number

    Pull request to publish the media to. Argos keeps a single comment on it listing every media uploaded, edited in place.

    project?: string

    Project to upload to, as owner/project. Required when authenticating with a personal access token; ignored with a project token, which already identifies its project.

    state?: MediaState

    Which half of a before/after pair these files are. Inferred from a file name ending in -before or -after; pass this to override it.

    token?: string

    Argos token. Falls back to ARGOS_TOKEN and to CI tokenless authentication, like every other Argos command.

    visibility?: "team" | "public"

    Who can open the share page. team requires an Argos session; public only requires the URL.

    Leave it out — the usual case — and the media takes the visibility of its project in Argos: public for a public project, team for a private one. team requires a paid plan.

    Settings
    Member Visibility

    On This Page
    Properties