Function: getComments()

function getComments(
   client, 
   parameters, 
   options?
): Promise<{
[key: string]: unknown;
  comments?: object[];
  maxResults?: number;
  startAt?: number;
  total?: number;
}>;

Defined in: src/server/api/issues.ts:552

Returns all comments for an issue. Results can be ordered by the 'created' field which means the date a comment was added.

Parameters

Parameter	Type	Description
client	Client	-
parameters	{ expand?: | string & object | "renderedBody" | (string & object | "renderedBody")[]; issueIdOrKey: string; maxResults?: number; orderBy?: string; startAt?: number; }	-
parameters.expand?	| string & object | "renderedBody" | (string & object | "renderedBody")[]	Optional flags: renderedBody (provides body rendered in HTML) This parameter accepts a comma-separated list.
parameters.issueIdOrKey?	string	Issue id or key
parameters.maxResults?	number	How many results on the page should be included. Defaults to 50.
parameters.orderBy?	string	Ordering of the results
parameters.startAt?	number	The page offset, if not specified then defaults to 0
options?	RequestOptions	-

Returns

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