Variable ProgressTrackerConst

Type Declaration

• _state: {
      startTime: number | null;
      lastUpdateTime: number | null;
      completed: number;
      total: number;
      downloadedSize: number;
      estimatedTotalSize: number;
      downloadedSinceLastUpdate: number;
      successfulDownloads: string[];
      failedDownloads: { url: string; error: string }[];
  }

• _config: { updateInterval: number; updateThreshold: number }

• init: function

  • init(options?: ProgressInitOptions): void

    Parameters

    • options: ProgressInitOptions = {}

    Returns void

• recordSuccess: function

  • recordSuccess(
        resource: { url: string; size?: number },
        callback?: (data: ProgressData) => void,
    ): ProgressData | null

    Record successful download

    Parameters

    • resource: { url: string; size?: number }

      Downloaded resource

      • url: string

        Resource URL

      • Optionalsize?: number

        Resource size in bytes

    • Optionalcallback: (data: ProgressData) => void

      Optional user callback

    Returns ProgressData | null

    Progress update or null if not emitted

• recordFailure: function

  • recordFailure(
        resource: { url: string },
        error: string,
        callback?: (data: ProgressData) => void,
    ): ProgressData | null

    Record failed download

    Parameters

    • resource: { url: string }

      Failed resource

      • url: string

        Resource URL

    • error: string

      Error message

    • Optionalcallback: (data: ProgressData) => void

      Optional user callback

    Returns ProgressData | null

    Progress update or null if not emitted

• emitProgress: function

  • emitProgress(callback?: (data: ProgressData) => void): ProgressData

    Force emit progress update

    Parameters

    • Optionalcallback: (data: ProgressData) => void

      Optional user callback

    Returns ProgressData

    Current progress data

• getSummary: function

  • getSummary(): {
        duration: number;
        completed: number;
        total: number;
        successful: number;
        failed: number;
        totalSize: number;
        averageSpeed: number;
        successfulDownloads: string[];
        failedDownloads: { url: string; error: string }[];
        failedUrls: string[];
    }

    Returns {
        duration: number;
        completed: number;
        total: number;
        successful: number;
        failed: number;
        totalSize: number;
        averageSpeed: number;
        successfulDownloads: string[];
        failedDownloads: { url: string; error: string }[];
        failedUrls: string[];
    }

• reset: function

  • reset(): void

    Returns void