✨ Features

• Thin & minimal low-level HTTP client to interact with Flapjack'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 flapjack-search client, you don't need to manually install @flapjack-search/client-search if you already have flapjack-search installed.

To get started, you first need to install @flapjack-search/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.

With a package manager

yarn add @flapjack-search/client-search@beta
# or
npm install @flapjack-search/client-search@beta
# or
pnpm add @flapjack-search/client-search@beta

Without a package manager

Add the following JavaScript snippet to the of your website:

<script src="https://cdn.jsdelivr.net/npm/@flapjack-search/client-search/dist/builds/browser.umd.js"></script>

Usage

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

import { searchClient } from '@flapjack-search/client-search';

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

For full documentation, visit the Flapjack 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 Flapjack JavaScript API Client is an open-sourced software licensed under the MIT license.