Interface MatchingProgressPropsInternal

Props for the MatchingProgressPanel component.

Source

export interface MatchingProgressProps {
  isCancelling: boolean;
  progress: MatchingProgress;
  statusMessage: string;
  timeEstimate: TimeEstimate;
  onCancelProcess: () => void;
  onPauseProcess?: () => void;
  onResumeProcess?: () => void;
  bypassCache?: boolean;
  freshSearch?: boolean;
  disableControls?: boolean;
  isPaused?: boolean;
  isManuallyPaused?: boolean;
  isRateLimitActive?: boolean;
}
interface MatchingProgressProps {
    isCancelling: boolean;
    progress: MatchingProgress;
    statusMessage: string;
    timeEstimate: TimeEstimate;
    onCancelProcess: () => void;
    onPauseProcess?: () => void;
    onResumeProcess?: () => void;
    bypassCache?: boolean;
    freshSearch?: boolean;
    disableControls?: boolean;
    isPaused?: boolean;
    isManuallyPaused?: boolean;
    isRateLimitActive?: boolean;
}

Properties

isCancelling progress statusMessage timeEstimate onCancelProcess onPauseProcess? onResumeProcess? bypassCache? freshSearch? disableControls? isPaused? isManuallyPaused? isRateLimitActive?

Properties

isCancelling

isCancelling: boolean

Whether the process is currently being cancelled.

progress

progress: MatchingProgress

The current progress state of the matching process.

statusMessage

statusMessage: string

The main status message to display.

timeEstimate

timeEstimate: TimeEstimate

Estimated time remaining for the process.

onCancelProcess

onCancelProcess: () => void

Callback to cancel the matching process.

OptionalonPauseProcess

onPauseProcess?: () => void

Callback to pause the matching process (optional).

OptionalonResumeProcess

onResumeProcess?: () => void

Callback to resume the matching process (optional).

OptionalbypassCache

bypassCache?: boolean

Whether to bypass the cache for matching (optional).

OptionalfreshSearch

freshSearch?: boolean

Whether a fresh search is being performed (optional).

OptionaldisableControls

disableControls?: boolean

Whether to disable control buttons (optional).

OptionalisPaused

isPaused?: boolean

Whether the process is currently paused (optional).

OptionalisManuallyPaused

isManuallyPaused?: boolean

Whether the pause was triggered manually (optional).

OptionalisRateLimitActive

isRateLimitActive?: boolean

Whether pause is due to an active rate limit (optional).

Settings

Member Visibility

On This Page

Properties