@bugbug-io/sdk
    Preparing search index...

    Class StepRunsModule

    Step runs module — fetch per-step execution details from a test run.

    Used to drill down into failure diagnostics: each test run owns N step runs, each of which carries timing, error code, and screenshot metadata.

    Index

    Constructors

    Methods

    Constructors

    • Parameters

      • client: BugBugApiClient

      Returns StepRunsModule

    Methods

    • Fetch full details for a single step run.

      Parameters

      • stepRunId: string

        UUID of the step run (from a TestRun.stepsRuns entry).

      • options: RequestOptions = {}

      Returns Promise<
          {
              id: string;
              stepId: string;
              testRunId: string;
              type: string;
              status?: | "error"
              | "passed"
              | "failed"
              | "running"
              | "auto_retrying"
              | "stopped"
              | "queued"
              | "paused"
              | "skipped"
              | "recording"
              | "initialized";
              error?: string
              | null;
              errorCode?: string | null;
              warning?: boolean;
              forceFailed?: boolean;
              ignoredFailed?: boolean;
              executed?: boolean | null;
              elementExists?: boolean | null;
              timeout?: boolean | null;
              executionUrl?: string | null;
              started?: string | null;
              ended?: string | null;
              duration?: string | null;
              runTimeout?: number | null;
              sleep?: number | null;
              screenshotUrl: string;
              coveringElementScreenshot: string;
              assertionExpectedValue?: string | null;
              assertionCurrentValue?: string | null;
              assertionType: string;
              assertionProperty: string;
              assertionAttributeName: string;
              tabNo: number;
              computedValue?: string | null;
              computedUrl?: string | null;
              computedUsername?: string | null;
              computedPassword?: string | null;
              computedFrameLocation?: string | null;
              computedAssertionExpectedValue?: string | null;
              computedSelector?: string | null;
              selector?: string | null;
              interactionPositionX?: number | null;
              interactionPositionY?: number | null;
              scrollX?: number | null;
              scrollY?: number | null;
              windowInnerWidth?: number | null;
              windowInnerHeight?: number | null;
              waitingConditions: {
                  type:
                      | "documentComplete"
                      | "elementIsVisible"
                      | "elementIsNotCovered"
                      | "elementIsNotAnimating"
                      | "elementIsNotDisabled"
                      | "elementHasFocus"
                      | "networkIdle"
                      | "pageNavigationAfterExecution"
                      | "elementHasAttribute";
                  isSuccess: boolean;
                  isSoftSuccess?: boolean;
                  isIgnored?: boolean;
                  expected?: string
                  | null;
                  current?: string | null;
              }[];
              visualRegressionRefScreenshotSourceId: string
              | null;
              visualRegressionCompareResult: {
                  refScreenshotUrl: string | null;
                  observedScreenshotUrl: string | null;
                  diffScreenshotUrl: string | null;
                  maxDiff: number;
                  observedDiff: number | null;
                  executionTime?: number | null;
                  browserName?: string | null;
                  osName?: string | null;
                  screenSizeType?: "" | "desktop" | "mobile" | "custom" | null;
                  runMode?: "" | "recording" | "server" | "local" | null;
                  profileName: string;
              };
          },
      >

      The step-run record including error code and timing.

      When no step run matches stepRunId.