Skip to content

Function: getReindexRequestProgress() ​

ts
function getReindexRequestProgress(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  completionTime?: Date;
  id?: number;
  requestTime?: Date;
  startTime?: Date;
  status?:   | string & object
     | "RUNNING"
     | "COMPLETE"
     | "FAILED"
     | "PENDING"
     | "ACTIVE";
  type?: string & object | "IMMEDIATE" | "DELAYED";
}>;

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

Retrieves the progress of a single reindex request.

Parameters ​

ParameterTypeDescription
clientClient-
parameters{ requestId: number; }-
parameters.requestIdnumberThe reindex request ID.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; completionTime?: Date; id?: number; requestTime?: Date; startTime?: Date; status?: | string & object | "RUNNING" | "COMPLETE" | "FAILED" | "PENDING" | "ACTIVE"; type?: string & object | "IMMEDIATE" | "DELAYED"; }>