Function: getReindexProgress()

function getReindexProgress(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  currentProgress?: number;
  currentSubTask?: string;
  finishTime?: Date;
  progressUrl?: string;
  startTime?: Date;
  submittedTime?: Date;
  success?: boolean;
  type?:   | string & object
     | "FOREGROUND"
     | "BACKGROUND"
     | "BACKGROUND_PREFFERED"
     | "BACKGROUND_PREFERRED";
}>;

Defined in: src/server/api/indexing.ts:167

Returns information on the system reindexes. If a reindex is currently taking place then information about this reindex is returned. If there is no active index task, then returns information about the latest reindex task run, otherwise returns a 404 indicating that no reindex has taken place.

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ taskId?: number; }	-
parameters.taskId?	number	The id of an indexing task you wish to obtain details on. If omitted, then defaults to the standard behaviour and returns information on the active reindex task, or the last task to run if no reindex is taking place.
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; currentProgress?: number; currentSubTask?: string; finishTime?: Date; progressUrl?: string; startTime?: Date; submittedTime?: Date; success?: boolean; type?: | string & object | "FOREGROUND" | "BACKGROUND" | "BACKGROUND_PREFFERED" | "BACKGROUND_PREFERRED"; }>