@algolia/client-composition

The perfect starting point to integrate Algolia within your JavaScript project

Documentation • InstantSearch • Community Forum • Stack Overflow • Report a bug • FAQ • Support

✨ Features

• Thin & minimal low-level HTTP client to interact with Algolia's API
• Works both on the browser and node.js
• UMD and ESM compatible, you can use it with any module loader
• Built with TypeScript

💡 Getting Started

[!TIP] This API client is already a dependency of the algoliasearch client, you don't need to manually install @algolia/client-composition if you already have algoliasearch installed.

To get started, you first need to install @algolia/client-composition (or any other available API client package). All of our clients comes with type definition, and are available for both browser and node environments.

With a package manager

yarn add @algolia/client-composition@0.0.1-alpha.0
# or
npm install @algolia/client-composition@0.0.1-alpha.0
# or
pnpm add @algolia/client-composition@0.0.1-alpha.0

Without a package manager

Add the following JavaScript snippet to the of your website:

<script src="https://cdn.jsdelivr.net/npm/@algolia/client-composition@0.0.1-alpha.0/dist/builds/browser.umd.js"></script>

Usage

You can now import the Algolia API client in your project and play with it.

import { compositionClient } from '@algolia/client-composition';

const client = compositionClient('YOUR_APP_ID', 'YOUR_API_KEY');

For full documentation, visit the Algolia JavaScript API Client.

❓ Troubleshooting

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

📄 License

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