Skip to content

Function: getPaginatedVersions() ​

ts
function getPaginatedVersions(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  isLast: boolean;
  maxResults: number;
  startAt: number;
  total?: number;
  values: object[];
}>;

Defined in: src/server/api/projectVersions.ts:30

Retrieve paginated collection of versions matching given query optionally filtered by given project IDs.

Parameters ​

ParameterTypeDescription
clientClient-
parameters?{ maxResults?: number; projectIds?: number[]; query?: string; startAt?: number; }-
parameters.maxResults?numberMaximum number of versions to return
parameters.projectIds?number[]Set of project IDs to filter versions with
parameters.query?stringString that version names will be matched with
parameters.startAt?numberIndex of the first version to return
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; isLast: boolean; maxResults: number; startAt: number; total?: number; values: object[]; }>