Function: getPaginatedComponents()

function getPaginatedComponents(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  isLast?: boolean;
  maxResults?: number;
  nextPage?: string;
  self?: string;
  startAt?: number;
  total?: number;
  values?: Record<string, any>[];
}>;

Defined in: src/server/api/projectComponents.ts:41

Returns paginated list of filtered active components

Parameters

Parameter	Type	Description
client	Client	-
parameters?	{ maxResults?: number; projectIds?: string; query?: string; startAt?: number; }	-
parameters.maxResults?	number	The maximum number of components to return
parameters.projectIds?	string	The set of project ids to filter components
parameters.query?	string	The string that components names will be matched with
parameters.startAt?	number	The index of the first components to return
options?	RequestOptions	-

Returns

Promise<{ [key: string]: unknown; isLast?: boolean; maxResults?: number; nextPage?: string; self?: string; startAt?: number; total?: number; values?: Record<string, any>[]; }>