nodes/generated

Interface CurrentsNodeParameters

Source
interface CurrentsNodeParameters {
    actionId?: string;
    actionTags?: string;
    actionType?: "tag" | "quarantine" | "skip";
    cancelGithubOptions?: {
        ciBuildId?: string;
        projectId?: string;
    };
    createOptions?: {
        description?: string;
        expiresAfter?: string;
    };
    dateEnd?: string;
    dateStart?: string;
    filters?: | {
        search?: string;
        status?: (
            "active"
            | "expired"
            | "archived"
            | "disabled"
        )[];
    }
    | {
        branch?: string;
        ciBuildId?: string;
        tags?: string;
    }
    | {
        authors?: string;
        branches?: string;
        completionState?: (
            | "IN_PROGRESS"
            | "CANCELED"
            | "COMPLETE"
            | "TIMEOUT"
        )[];
        dateEnd?: string;
        dateStart?: string;
        search?: string;
        status?: ("FAILED" | "FAILING" | "PASSED" | "RUNNING")[];
        tagOperator?: "AND" | "OR";
        tags?: string;
    }
    | {
        authors?: string;
        branches?: string;
        groups?: string;
        specNameFilter?: string;
        tags?: string;
    }
    | {
        authors?: string;
        branches?: string;
        groups?: string;
        minExecutions?: number;
        spec?: string;
        tags?: string;
        testState?: (
            "pending"
            | "failed"
            | "passed"
            | "skipped"
        )[];
        title?: string;
    }
    | {
        authors?: string;
        branches?: string;
        groups?: string;
        status?: ("pending" | "failed" | "passed" | "skipped")[];
        tags?: string;
    };
    githubRunAttempt?: number;
    githubRunId?: string;
    instanceId?: string;
    limit?: number;
    machineIds?: string;
    matcherType?: | "signature"
    | "specContains"
    | "specEquals"
    | "titleContains"
    | "titleEquals";
    matcherValue?: string;
    name?: string;
    operation?: | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "generate"
    | "cancel"
    | "disable"
    | "enable"
    | "getInsights"
    | "cancelGithub"
    | "find"
    | "reset";
    options?: | {
        authors?: string;
        branches?: string;
        groups?: string;
        resolution?: "1h"
        | "1d"
        | "1w";
        tags?: string;
    }
    | { endingBefore?: string; startingAfter?: string }
    | {
        dir?: "asc" | "desc";
        includeFailedInDuration?: boolean;
        order?:
            | "avgDuration"
            | "failedExecutions"
            | "failureRate"
            | "flakeRate"
            | "flakyExecutions"
            | "fullyReported"
            | "overallExecutions"
            | "suiteSize"
            | "timeoutExecutions"
            | "timeoutRate";
        page?: number;
    }
    | {
        dir?: "asc"
        | "desc";
        metric_settings?: string;
        order?:
            | "duration"
            | "durationDelta"
            | "durationXSamples"
            | "executions"
            | "failRateXSamples"
            | "failureRateDelta"
            | "failures"
            | "flakiness"
            | "flakinessXSamples"
            | "flakinessRateDelta"
            | "passes"
            | "title";
        page?: number;
    };
    projectId?: { mode: "id"
    | "list"; value: string };
    resetOptions?: { isBatchedOr8n?: boolean };
    resource?:
        | "test"
        | "signature"
        | "run"
        | "project"
        | "action"
        | "instance"
        | "specFile"
        | "testResult";
    runId?: string;
    signature?: string;
    specFilePath?: string;
    testTitle?: string;
    updateFields?: {
        description?: string;
        expiresAfter?: string;
        name?: string;
    };
}

Properties§

§readonly actionId?: string

The ID of the action

§readonly actionTags?: string

Comma-separated list of tags to apply

§readonly actionType?: "tag" | "quarantine" | "skip"

Default: "quarantine"

§readonly cancelGithubOptions?: { ... }

Default: {}

§readonly createOptions?: { ... }

Default: {}

§readonly dateEnd?: string

End date for metrics (ISO 8601 format)

§readonly dateStart?: string

Start date for metrics (ISO 8601 format)

§readonly filters?:
    | {
        search?: string;
        status?: (
            "active"
            | "expired"
            | "archived"
            | "disabled"
        )[];
    }
    | {
        branch?: string;
        ciBuildId?: string;
        tags?: string;
    }
    | {
        authors?: string;
        branches?: string;
        completionState?: (
            | "IN_PROGRESS"
            | "CANCELED"
            | "COMPLETE"
            | "TIMEOUT"
        )[];
        dateEnd?: string;
        dateStart?: string;
        search?: string;
        status?: ("FAILED" | "FAILING" | "PASSED" | "RUNNING")[];
        tagOperator?: "AND" | "OR";
        tags?: string;
    }
    | {
        authors?: string;
        branches?: string;
        groups?: string;
        specNameFilter?: string;
        tags?: string;
    }
    | {
        authors?: string;
        branches?: string;
        groups?: string;
        minExecutions?: number;
        spec?: string;
        tags?: string;
        testState?: (
            "pending"
            | "failed"
            | "passed"
            | "skipped"
        )[];
        title?: string;
    }
    | {
        authors?: string;
        branches?: string;
        groups?: string;
        status?: ("pending" | "failed" | "passed" | "skipped")[];
        tags?: string;
    }

Default: {}

§readonly githubRunAttempt?: number

The GitHub Actions workflow attempt number Default: 1

§readonly githubRunId?: string

The GitHub Actions workflow run ID

§readonly instanceId?: string

The ID of the spec file execution instance

§readonly limit?: number

Max number of results to return Default: 10 Type options: {"minValue":1,"maxValue":50}

§readonly machineIds?: string

Comma-separated list of machine identifiers to reset (1-63 items)

§readonly matcherType?:
    | "signature"
    | "specContains"
    | "specEquals"
    | "titleContains"
    | "titleEquals"

How to match tests for this action Default: "titleContains"

§readonly matcherValue?: string

The value to match against (test title, spec file path, or signature)

§readonly name?: string

The name of the action (1-255 characters)

§readonly operation?:
    | "create"
    | "get"
    | "getAll"
    | "update"
    | "delete"
    | "generate"
    | "cancel"
    | "disable"
    | "enable"
    | "getInsights"
    | "cancelGithub"
    | "find"
    | "reset"

Default: "getAll"

§readonly options?:
    | {
        authors?: string;
        branches?: string;
        groups?: string;
        resolution?: "1h"
        | "1d"
        | "1w";
        tags?: string;
    }
    | { endingBefore?: string; startingAfter?: string }
    | {
        dir?: "asc" | "desc";
        includeFailedInDuration?: boolean;
        order?:
            | "avgDuration"
            | "failedExecutions"
            | "failureRate"
            | "flakeRate"
            | "flakyExecutions"
            | "fullyReported"
            | "overallExecutions"
            | "suiteSize"
            | "timeoutExecutions"
            | "timeoutRate";
        page?: number;
    }
    | {
        dir?: "asc"
        | "desc";
        metric_settings?: string;
        order?:
            | "duration"
            | "durationDelta"
            | "durationXSamples"
            | "executions"
            | "failRateXSamples"
            | "failureRateDelta"
            | "failures"
            | "flakiness"
            | "flakinessXSamples"
            | "flakinessRateDelta"
            | "passes"
            | "title";
        page?: number;
    }

Default: {}

§readonly projectId?: { ... }

The Currents project Default: {"mode":"list","value":""}

§readonly resetOptions?: { ... }

Default: {}

§readonly resource?:
    | "test"
    | "signature"
    | "run"
    | "project"
    | "action"
    | "instance"
    | "specFile"
    | "testResult"

Default: "run"

§readonly runId?: string

The ID of the run

§readonly signature?: string

The unique test signature. Use the Signature resource to generate this from project ID, spec file path, and test title.

§readonly specFilePath?: string

The complete path to the spec file

§readonly testTitle?: string

The test title. For nested describe blocks, use " > " as separator (e.g., "Login > should login with valid credentials").

§readonly updateFields?: { ... }

Default: {}