What it is

algoliasearch-client-javascript is an open-source JavaScript API client for Algolia, built with TypeScript and distributed under the MIT license. It provides a thin and minimal low-level HTTP client for interacting with Algolia's API from both browser and Node.js environments. The project sits in the JavaScript and TypeScript package ecosystem, where it serves as a starting point for integrating Algolia into JavaScript projects.

The concrete problem it solves is giving JavaScript projects a ready-made client for Algolia's API. The README describes the package as a thin and minimal low-level HTTP client, so developers do not need to write their own transport code for browser and Node.js requests. It also addresses module compatibility by supporting UMD and ESM, and it addresses typing by being built with TypeScript and coming with type definitions.

Key capabilities

• It provides a thin and minimal low-level HTTP client for Algolia's API.
• It works in browser and Node.js environments.
• It is compatible with UMD and ESM module loading.
• It is built with TypeScript and comes with type definitions.
• It offers both a full client and a lite client.
• It is available through package managers such as yarn, npm, and pnpm.
• It can be added directly to a website without a package manager.

Who uses it and how

• JavaScript developers add algoliasearch to a project to call Algolia API methods.
• Browser applications can import the client and initialize it with an Algolia application ID and API key.
• Node.js applications can use the same package for server-side integration with Algolia.
• Projects using different module loaders can use the UMD and ESM compatible client.
• Developers needing a lite client can import liteClient from algoliasearch/lite.

Getting started

Install [email protected] with yarn, npm, or pnpm, then import algoliasearch or liteClient and create a client with an application ID and API key. For use without a package manager, add the provided JavaScript snippet to a website.

When to use it — and when not to

Use it when a JavaScript or TypeScript project needs direct access to Algolia's API. Do not use it when the project cannot provide an Algolia application ID and API key, because the README shows those values as required for initialization. It is an API client, not the Algolia API itself, so teams still need Algolia API access to perform search operations.

yarn add [email protected]
# or
npm install [email protected]
# or
pnpm add [email protected]

// for the full client
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/algoliasearch.umd.js"></script>

// for the lite client
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/lite/builds/browser.umd.js"></script>

import { algoliasearch } from 'algoliasearch';

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

// or with the lite client
import { liteClient } from 'algoliasearch/lite';

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