Skip to content

algolia/algoliasearch-client-javascript

Repository files navigation

Algolia for JavaScript

The perfect starting point to integrate Algolia within your JavaScript project

Build StatusNPM versionNPM downloadsjsDelivr DownloadsLicense

DocumentationInstantSearchCommunity ForumStack OverflowReport a bugSupport

✨ Features

  • Thin & minimal low-level HTTP client to interact with Algolia's API
  • Works both on the browser and node.js
  • UMD compatible, you can use it with any module loader
  • Contains type definitions: @types/algoliasearch

💡 Getting Started

First, install Algolia JavaScript API Client via the npm package manager:

npm install --save algoliasearch

Then, create objects on your index:

constalgoliasearch=require('algoliasearch');constclient=algoliasearch('YourApplicationID','YourAdminAPIKey');constindex=client.initIndex('your_index_name');constobjects=[{objectID: 1,name: 'Foo'}];index.saveObjects(objects).then(({ objectIDs })=>{console.log(objectIDs);}).catch(err=>{console.log(err);});

Finally, let's actually search using the search method:

index.search('Fo').then(({ hits })=>{console.log(hits);}).catch(err=>{console.log(err);});

For full documentation, visit the online documentation.

📄 License

Algolia JavaScript API Client is an open-sourced software licensed under the MIT license.