npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@elastic/search-ui-app-search-connector

v1.22.0

Published

⚠️ DEPRECATED. Please use '@elastic/search-ui-elasticsearch-connector'.

Downloads

60,584

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. |