@elastic/search-ui-app-search-connector
v1.22.0
Published
⚠️ DEPRECATED. Please use '@elastic/search-ui-elasticsearch-connector'.
Downloads
60,584
Maintainers
Keywords
Readme
search-ui-app-search-connector
Part of the Search UI project.
This Connector is used to connect Search UI to Elastic's App Search API.
⚠️ Deprecation Notice
Note: The AppSearchConnector
package is deprecated and will no longer be supported. Please migrate to Elasticsearch Connector for continued support.
Usage
npm install --save @elastic/search-ui-app-search-connector
import AppSearchAPIConnector from "@elastic/search-ui-app-search-connector";
const connector = new AppSearchAPIConnector({
searchKey: "search-371auk61r2bwqtdzocdgutmg",
engineName: "search-ui-examples",
endpointBase: "http://127.0.0.1:3002"
});
Swiftype.com App Search users:
When using the SaaS version available on swiftype.com of App Search, you can configure the connector using your hostIdentifier
instead of the endpointBase
parameter.
The hostIdentifier
can be found within the Credentials menu.
const connector = new AppSearchAPIConnector({
searchKey: "search-371auk61r2bwqtdzocdgutmg",
engineName: "search-ui-examples",
hostIdentifier: "host-c5s2mj"
});
Additional options
Additional options will be passed through to the underlying APIclient. Any valid parameter of the client can be used.
const connector = new AppSearchAPIConnector({
searchKey: "search-371auk61r2bwqtdzocdgutmg",
engineName: "search-ui-examples",
endpointBase: "http://127.0.0.1:3002",
cacheResponses: false
});
Classes
Typedefs
AppSearchAPIConnector
Kind: global class
new AppSearchAPIConnector(options)
| Param | Type | | ------- | -------------------------------- | | options | Options |
next : function
Kind: global typedef
| Param | Type | Description | | ------------------- | ------------------- | ------------------------------ | | updatedQueryOptions | Object | The options to send to the API |
hook : function
Kind: global typedef
| Param | Type | Description | | ------------ | -------------------------- | ------------------------------------------------ | | queryOptions | Object | The options that are about to be sent to the API | | next | next | The options that are about to be sent to the API |
Options
Kind: global typedef
| Param | Type | Default | Description | | --------------------------------- | -------------------------- | ------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- | | searchKey | string | | Credential found in your App Search Dashboard | | engineName | string | | Engine to query, found in your App Search Dashboard | | hostIdentifier | string | | Credential found in your App Search Dashboard Useful when proxying the Swiftype API or developing against a local API server. | | beforeSearchCall | hook | (queryOptions,next)=>next(queryOptions) | A hook to amend query options before the request is sent to the API in a query on an "onSearch" event. | | beforeAutocompleteResultsCall | hook | (queryOptions,next)=>next(queryOptions) | A hook to amend query options before the request is sent to the API in a "results" query on an "onAutocomplete" event. | | beforeAutocompleteSuggestionsCall | hook | (queryOptions,next)=>next(queryOptions) | A hook to amend query options before the request is sent to the API in a "suggestions" query on an "onAutocomplete" event. | | endpointBase | string | "" | Overrides the base of the Swiftype API endpoint completely. |