React SDK

Variables

The Variables class is a simple key -> value pair object used for every search request. It includes critical data such as the query, results per page, current page, etc.

Constructor

The constructor will accept a single object with any properties. The proprties will vary based on your pipeline configuration but the most common implementations will use the following:

Value types can be string | string[] | number | boolean | () => string

NameDefaultDescription
qThe search query.
q.override
q.suggestionsDictionary of name -> filter pairs.
filter_id != ""Default filter to apply.
resultsPerPage15How many results to display per page.
page1Which page to display.
fields''What fields are shown in the response. Use "" to show all fields.