Skip to content

Latest commit

 

History

History
120 lines (91 loc) · 5.27 KB

README.md

File metadata and controls

120 lines (91 loc) · 5.27 KB

Meilisearch-JavaScript

Meilisearch JavaScript

Meilisearch | Meilisearch Cloud | Documentation | Discord | Roadmap | Website | FAQ

npm version Tests Codecov Prettier License Bors enabled

⚡ The Meilisearch API client written for JavaScript

Meilisearch JavaScript is the Meilisearch API client for JavaScript developers.

Meilisearch is an open-source search engine. Learn more about Meilisearch.

Run Meilisearch

⚡️ Launch, scale, and streamline in minutes with Meilisearch Cloud—no maintenance, no commitment, cancel anytime. Try it free now.

🪨 Prefer to self-host? Download and deploy our fast, open-source search engine on your own infrastructure.

🔧 Installation

Package is published to npm.

Installing with npm:

npm i meilisearch

Note

Node.js LTS and Maintenance versions are supported and tested. Other versions may or may not work. TypeScript has to be set up so that it supports package.json "exports" field.

Other runtimes, like Deno and Bun, aren't tested, but if they do not work with this package, please open an issue.

This package also contains a UMD bundled version, which is meant to be used in a script src tag:

<script src="https://www.unpkg.com/meilisearch/dist/umd/index.min.js"></script>
<script>
  const client = new meilisearch.MeiliSearch(/* ... */);
  // ...
</script>

Warning

  • default export is deprecated and will be removed in a future version | Issue
  • regarding usage of package's UMD version via script src, exports will stop being directly available on the global object | Issue

📖 Documentation

Refer to the client library documentation for information on each exported item of this package.

For general information on how to use Meilisearch—such as our API reference, tutorials, guides, and in-depth articles—refer to our main documentation website.

🚀 Example code

Take a look at the playground to see an example.

🤖 Compatibility with Meilisearch

This package guarantees compatibility with the latest version of Meilisearch.

⚙️ Contributing

We welcome all contributions, big and small! If you want to know more about this SDK's development workflow or want to contribute to the repo, please visit our contributing guidelines for detailed instructions.

Meilisearch provides and maintains many SDKs and integration tools like this one. We want to provide everyone with an amazing search experience for any kind of project. For a full overview of everything we create and maintain, take a look at the integration-guides repository.