@esm-js/jira.js/src/agile/models/searchResults.ts

A comprehensive JavaScript/TypeScript library designed for both Node.JS and browsers, facilitating seamless interaction with the Atlassian Jira API.

import type { Issue } from './issue';

/** The result of a JQL search. */
export interface SearchResults {
  /** Expand options that include additional search result details in the response. */
  expand?: string;
  /** The list of issues found by the search. */
  issues: Issue[];
  /** The maximum number of results that could be on the page. */
  maxResults: number;
  /** The ID and name of each field in the search results. */
  names?: unknown;
  /** The schema describing the field types in the search results. */
  schema?: unknown;
  /** The index of the first item returned on the page. */
  startAt: number;
  /** The number of results on the page. */
  total: number;
  /** Any warnings related to the JQL query. */
  warningMessages?: string[];
}