Class: Response

Response

new Response()

Embodies the response of a SearchForm query as returned by the API. It includes all the fields that are useful for pagination (page, total_pages, total_results_size, ...), as well as the field "results", which is an array of Document objects, the documents themselves.
Source:

Members

next_page :string

The URL of the next page in the API
Type:
  • string
Source:

page :number

The current page
Type:
  • number
Source:

prev_page :string

The URL of the previous page in the API
Type:
  • string
Source:

results :Array

Array of Document for the current page
Type:
  • Array
Source:

results_per_page :number

The number of results per page
Type:
  • number
Source:

results_size :number

The size of the current page
Type:
  • number
Source:

total_pages :number

The total number of pages
Type:
  • number
Source:

total_results_size :number

The total size of results across all pages
Type:
  • number
Source: