@qtsurfer/api-client
    Preparing search index...

    Type Alias PrepareJobState

    PrepareJobState: JobState & {
        coverageRatio?: number;
        dataFrom?: string | null;
        dataTo?: string | null;
        hoursWithData?: number;
        hoursWithoutData?: {
            expected?: number;
            hour?: string;
            rationale?: "pending_conversion" | "low_activity" | "unknown";
        }[];
        totalHours?: number;
    }

    State of a single-instrument prepare job — the JobState shape plus a per-hour data-coverage summary. A single-instrument prepare is always terminal (status: Completed): the client decides what to do from coverageRatio (e.g. execute if it is at or above a chosen threshold) rather than polling for missing hours that may never arrive — a missing hour for one instrument usually means low activity, not missing data.

    Type Declaration

    • OptionalcoverageRatio?: number

      hoursWithData / totalHours in [0,1] (1.0 when totalHours is 0) — the fraction of hours in the requested range that have served data.

    • OptionaldataFrom?: string | null

      Start of the available data range for the prepared instrument.

    • OptionaldataTo?: string | null

      End of the available data range for the prepared instrument.

    • OptionalhoursWithData?: number

      Number of hours in the range that have data.

    • OptionalhoursWithoutData?: {
          expected?: number;
          hour?: string;
          rationale?: "pending_conversion" | "low_activity" | "unknown";
      }[]

      One entry per hour in the range that has no data, with a rationale.

    • OptionaltotalHours?: number

      Number of whole hours in the requested prepare range.

    Settings
    Member Visibility