Class: KlevuResponseObject
This class is used to access the response data from Klevu API It builds up the state of the result and it can be used to do various things with the data
Table of contents
Constructors
- constructorconstructor
Properties
- #functions#functions
- #queryObjects#queryObjects
- apiResponseapiResponse
Methods
- #buildQueryObjects#buildQueryObjects
- queriesByIdqueriesById
- queryExistsqueryExists
- suggestionsByIdsuggestionsById
Constructors
constructor
• new KlevuResponseObject(response, functions)
Parameters
Name | Type |
|---|---|
response | KlevuApiRawResponseKlevuApiRawResponse |
functions | KlevuFetchFunctionReturnValueKlevuFetchFunctionReturnValue[] |
Defined in
Properties
#functions
• Private #functions: KlevuFetchFunctionReturnValueKlevuFetchFunctionReturnValue[]
Defined in
#queryObjects
• Private #queryObjects: Object = {}
Index signature
▪ [id: string]: KlevuResponseQueryObjectKlevuResponseQueryObject
Defined in
apiResponse
• apiResponse: KlevuApiRawResponseKlevuApiRawResponse
Defined in
Methods
#buildQueryObjects
▸ Private #buildQueryObjects(): void
Returns
void
Defined in
queriesById
▸ queriesById(id): KlevuResponseQueryObjectKlevuResponseQueryObject
Get query results by id
Parameters
Name | Type | Description |
|---|---|---|
id | string | query id used |
Returns
KlevuResponseQueryObjectKlevuResponseQueryObject
Defined in
queryExists
▸ queryExists(id): boolean
Check if query exists. This should be used as queriesById can throw an error
Parameters
Name | Type | Description |
|---|---|---|
id | string | query id used |
Returns
boolean
Defined in
suggestionsById
▸ suggestionsById(id): undefined | KlevuSuggestionResultKlevuSuggestionResult
Get suggestions by id
Parameters
Name | Type |
|---|---|
id | string |
Returns
undefined | KlevuSuggestionResultKlevuSuggestionResult