Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SearchParams

SearchParams used in search query execution.

Hierarchy

  • SearchParams

Index

Properties

Properties

fields

fields: object

fields to retrieve for each document.

limit

limit: number

limit on documents to retreive.

Paging is based on this number and not the total possible result.

page

page: number

page to begin retrieving documents.

query

query: Object

query object used to filter documents.

sort

sort: Object

sort object.

Generated using TypeDoc