Type Alias QixProgressEvent

QixProgressEvent:
    | QixProgressEventBase & { status: "started" }
    | QixProgressEventBase & {
        awaitingUserInteraction: boolean;
        errors: QixProgressError[];
        persistent: QixProgressMessage[];
        status: "progress";
        transient: QixProgressMessage;
    }
    | QixProgressEventBase & {
        durationMs: number;
        errors: QixProgressError[];
        persistent: QixProgressMessage[];
        status: "finished";
    }
    | QixProgressEventBase & {
        errors: QixProgressError[];
        persistent: QixProgressMessage[];
        status: "error";
    }
    | QixProgressEventBase & {
        errors: QixProgressError[];
        persistent: QixProgressMessage[];
        status: "aborted";
    }

A cleaned-up, synthetic progress event derived from the engine's raw GetProgress responses.

The lifecycle is started -> progress (zero or more) -> a terminal event, one of:

  • finished: the operation completed successfully.
  • error: the operation ran but ended in an error the user should examine (a failed reload).
  • aborted: the operation was interrupted, e.g. the websocket connection was lost.

persistent is the accumulated log of completed steps (oldest first) and transient is the message that is currently changing. A typical display shows every persistent message followed by the transient one when it differs from the last persistent message.

Type Declaration

  • QixProgressEventBase & { status: "started" }
  • QixProgressEventBase & {
        awaitingUserInteraction: boolean;
        errors: QixProgressError[];
        persistent: QixProgressMessage[];
        status: "progress";
        transient: QixProgressMessage;
    }
    • awaitingUserInteraction: boolean

      True while the engine is paused waiting for a debug-mode user interaction (qUserInteractionWanted).

    • errors: QixProgressError[]

      Errors and warnings discovered so far.

    • persistent: QixProgressMessage[]

      Log of completed steps accumulated across the whole request, oldest first (qPersistentProgressMessages).

    • status: "progress"
    • transient: QixProgressMessage

      What is happening right now; replaced on every event (qTransientProgressMessage).

  • QixProgressEventBase & {
        durationMs: number;
        errors: QixProgressError[];
        persistent: QixProgressMessage[];
        status: "finished";
    }
    • durationMs: number

      Total time the request took, in milliseconds (qMillisecs).

    • errors: QixProgressError[]

      Any warnings reported during the request.

    • persistent: QixProgressMessage[]

      Full log of completed steps, oldest first.

    • status: "finished"
  • QixProgressEventBase & {
        errors: QixProgressError[];
        persistent: QixProgressMessage[];
        status: "error";
    }
    • errors: QixProgressError[]

      Errors and warnings reported for the failed request.

    • persistent: QixProgressMessage[]

      Log of completed steps recorded before the request failed, oldest first.

    • status: "error"
  • QixProgressEventBase & {
        errors: QixProgressError[];
        persistent: QixProgressMessage[];
        status: "aborted";
    }
    • errors: QixProgressError[]

      Errors and warnings reported before the request was interrupted.

    • persistent: QixProgressMessage[]

      Log of completed steps recorded before the request was interrupted, oldest first.

    • status: "aborted"

Settings
Member Visibility