Skip to content

Latest commit

 

History

History
110 lines (104 loc) · 2.75 KB

options.md

File metadata and controls

110 lines (104 loc) · 2.75 KB

Document Options

Option Values Description Default
id
String "id""
tag

false
String
"tag"
index


String
Array<String>
Array<Object>
store


Boolean
String
Array<String>
false

Search Options

Option Values Description Default
limit number Sets the limit of results. 100
offset number Apply offset (skip items). 0
suggest Boolean Enables suggestions in results. false

Document Search Options

Option Values Description Default
index String
Array<String>
Array<Object>
Sets the document fields which should be searched. When no field is set, all fields will be searched. Custom options per field are also supported.
tag String
Array<String>
Sets the document fields which should be searched. When no field is set, all fields will be searched. Custom options per field are also supported. false
enrich Boolean Enrich IDs from the results with the corresponding documents. false
bool "and"
"or"
Sets the used logical operator when searching through multiple fields or tags. "or"