algoliasearch client javascript

将 Algolia 集成到 JavaScript 项目中的完美起点

文档 • InstantSearch • 社区论坛 • Stack Overflow • 报告错误 • 常见问题解答 • 支持

特征

• 与 Algolia 的 API 交互的精简且最小的低级 HTTP 客户端
• 适用于浏览器和Node.js
• UMD 和 ESM 兼容，您可以将其与任何模块加载器一起使用
• 使用 TypeScript 构建

入门

首先，您需要安装 algoliasearch（或任何其他可用的 API 客户端包）。我们所有的客户端都带有类型定义，并且可用于浏览器和节点环境。

使用包管理器

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

没有包管理器

将以下 JavaScript 代码段添加到您网站的：

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

用法

您现在可以在项目中导入 Algolia API 客户端并使用它。

 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' ) ;

如需完整文档，请访问Algolia JavaScript API 客户端。

❓ 故障排除

遇到问题？在寻求支持之前，我们建议先查看我们的常见问题解答，您可以在其中找到最常见问题和客户遇到的问题的答案。您还可以打开 GitHub 问题

？执照

Algolia JavaScript API 客户端是一款根据 MIT 许可证授权的开源软件。