Skip to content

Function: getFieldAutoCompleteForQueryString() ​

ts
function getFieldAutoCompleteForQueryString(
   client, 
   parameters?, 
   options?
): Promise<{
[key: string]: unknown;
  results?: object[];
}>;

Defined in: src/server/api/jql.ts:19

Returns auto complete suggestions for JQL search

Parameters ​

ParameterTypeDescription
clientClient-
parameters?{ fieldName?: string; fieldValue?: string; predicateName?: string; predicateValue?: string; }-
parameters.fieldName?stringThe field name for which the suggestions are generated.
parameters.fieldValue?stringThe portion of the field value that has already been provided by the user.
parameters.predicateName?stringThe predicate for which the suggestions are generated. Suggestions are generated only for: "by", "from" and "to".
parameters.predicateValue?stringThe portion of the predicate value that has already been provided by the user.
options?RequestOptions-

Returns ​

Promise<{ [key: string]: unknown; results?: object[]; }>