Module "wordpress-plugins/real-cookie-banner/src/public/ts/hooks/useScannerProgress"

useScannerProgress

• useScannerProgress(fetchStatusInterval?: UseProgressParameters["fetchStatusInterval"], fetchAdditionalData?: false | "rcb-scan-list" | "rcb-scan-notice", onCancel?: UseProgressParameters["onCancel"]): { cancelling: boolean; currentJob: Job<JobData>; errors: { actions: Array<{ action?: "delete" | "retry" | "skip"; linkText: string; target?: string; url: string }>; description: string; failedJobs: Job[]; label: string; type: string }; failure: number; handleCancel: (Anonymous function); jobsStarted: boolean; paused: number; percent: number; remaining: number; status: "done" | "not-started" | "failed"; total: number }

• Returns the status / progress of the scanner.

  Parameters

  • Optional fetchStatusInterval: UseProgressParameters["fetchStatusInterval"]

  • Default value fetchAdditionalData: false | "rcb-scan-list" | "rcb-scan-notice" = false

  • Optional onCancel: UseProgressParameters["onCancel"]

  Returns { cancelling: boolean; currentJob: Job<JobData>; errors: { actions: Array<{ action?: "delete" | "retry" | "skip"; linkText: string; target?: string; url: string }>; description: string; failedJobs: Job[]; label: string; type: string }; failure: number; handleCancel: (Anonymous function); jobsStarted: boolean; paused: number; percent: number; remaining: number; status: "done" | "not-started" | "failed"; total: number }

  • cancelling: boolean

  • currentJob: Job<JobData>

  • errors: { actions: Array<{ action?: "delete" | "retry" | "skip"; linkText: string; target?: string; url: string }>; description: string; failedJobs: Job[]; label: string; type: string }

    • actions: Array<{ action?: "delete" | "retry" | "skip"; linkText: string; target?: string; url: string }>

    • description: string

    • failedJobs: Job[]

    • label: string

    • type: string

  • failure: number

  • handleCancel: (Anonymous function)

  • jobsStarted: boolean

  • paused: number

  • percent: number

  • remaining: number

  • status: "done" | "not-started" | "failed"

  • total: number