@algolia/client-search
Advanced tools
The @algolia/client-search npm package is designed to facilitate seamless integration with Algolia's search API, enabling developers to easily implement search functionality within their applications. It provides a comprehensive set of features for indexing and querying searchable data, managing indices, and configuring search parameters for optimized search experiences.
Search in an index
This feature allows you to perform a search query on a specific index. The search results are returned as 'hits'.
{"searchIndex.search('query').then(({ hits }) => console.log(hits));"}Save objects to an index
This feature enables you to save objects to an index, which can then be searched. Objects must have an 'objectID' or it can be auto-generated.
{"index.saveObjects([{ objectID: '1', name: 'John Doe' }], { autoGenerateObjectIDIfNotExist: true }).then(({ objectIDs }) => console.log(objectIDs));"}Configure index settings
This feature allows you to configure various settings for an index, such as defining which attributes are searchable.
{"index.setSettings({ searchableAttributes: ['name', 'email'] }).then(() => console.log('Settings updated'));"}Elasticsearch is a distributed, RESTful search and analytics engine capable of addressing a growing number of use cases. While @algolia/client-search is specifically designed for integration with Algolia's managed search services, Elasticsearch offers a more flexible, self-hosted solution that requires manual setup and management.
solr-node is a client library for interacting with Apache Solr, a powerful open-source search platform. Similar to Elasticsearch, Solr provides extensive search capabilities but requires self-hosting and management. Compared to @algolia/client-search, solr-node targets users who prefer or require more control over their search infrastructure.
Documentation • InstantSearch • Community Forum • Stack Overflow • Report a bug • FAQ • Support
[!TIP] This API client is already a dependency of the algoliasearch client, you don't need to manually install
@algolia/client-searchif you already havealgoliasearchinstalled.
To get started, you first need to install @algolia/client-search (or any other available API client package). All of our clients comes with type definition, and are available for both browser and node environments.
yarn add @algolia/client-search@5.9.0
# or
npm install @algolia/client-search@5.9.0
# or
pnpm add @algolia/client-search@5.9.0
Add the following JavaScript snippet to the of your website:
<script src="https://cdn.jsdelivr.net/npm/@algolia/client-search@5.9.0/dist/builds/browser.umd.js"></script>
You can now import the Algolia API client in your project and play with it.
import { searchClient } from '@algolia/client-search';
const client = searchClient('YOUR_APP_ID', 'YOUR_API_KEY');
For full documentation, visit the Algolia JavaScript API Client.
Encountering an issue? Before reaching out to support, we recommend heading to our FAQ where you will find answers for the most common issues and gotchas with the client. You can also open a GitHub issue
The Algolia JavaScript API Client is an open-sourced software licensed under the MIT license.
FAQs
JavaScript client for client-search
The npm package @algolia/client-search receives a total of 2,057,529 weekly downloads. As such, @algolia/client-search popularity was classified as popular.
We found that @algolia/client-search demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
An advanced npm supply chain attack is leveraging Ethereum smart contracts for decentralized, persistent malware control, evading traditional defenses.
Security News
Research
Attackers are impersonating Sindre Sorhus on npm with a fake 'chalk-node' package containing a malicious backdoor to compromise developers' projects.
Security News
The npm package for the LottieFiles Player web component was hit with a supply chain attack after a software engineer's npmjs credentials were compromised.