meilisearch

Meilisearch JavaScript

Meilisearch | Documentation | Slack | Roadmap | Website | FAQ

⚡ The Meilisearch API client written for JavaScript

Meilisearch JavaScript is the Meilisearch API client for JavaScript developers.

Meilisearch is an open-source search engine. Discover what Meilisearch is!

Table of Contents

• 📖 Documentation
• 🔧 Installation
• 🎬 Getting Started
• 🤖 Compatibility with Meilisearch
• 💡 Learn More
• ⚙️ Development Workflow and Contributing
• 📜 API Resources

📖 Documentation

See our Documentation or our API References.

🔧 Installation

We only guarantee that the package works with node >= 12 and node <= 16.

With npm:

npm install meilisearch

With yarn:

yarn add meilisearch

🏃‍♀️ Run Meilisearch

There are many easy ways to download and run a Meilisearch instance.

For example, using the curl command in your Terminal:

# Install Meilisearch
curl -L https://install.meilisearch.com | sh

# Launch Meilisearch
./meilisearch --master-key=masterKey

NB: you can also download Meilisearch from Homebrew or APT or even run it using Docker.

Import

Depending on the environment in which you are using Meilisearch, imports may differ.

Import Syntax

Usage in an ES module environment:

import { MeiliSearch } from 'meilisearch'

const client = new MeiliSearch({
  host: 'http://127.0.0.1:7700',
  apiKey: 'masterKey',
})

Include Script Tag

Usage in an HTML (or alike) file:

<script src='https://cdn.jsdelivr.net/npm/meilisearch@latest/dist/bundles/meilisearch.umd.js'></script>
<script>
  const client = new MeiliSearch({
    host: 'http://127.0.0.1:7700',
    apiKey: 'masterKey',
  })
</script>

Require Syntax

Usage in a back-end node environment

const { MeiliSearch } = require('meilisearch')

const client = new MeiliSearch({
  host: 'http://127.0.0.1:7700',
  apiKey: 'masterKey',
})

React Native

To make this package work with React Native, please add the react-native-url-polyfill.

Deno

Usage in a back-end deno environment

import { MeiliSearch } from "https://esm.sh/meilisearch"

const client = new MeiliSearch({
  host: 'http://127.0.0.1:7700',
  apiKey: 'masterKey',
})

🎬 Getting Started

Add Documents

const { MeiliSearch } = require('meilisearch')
// Or if you are in a ES environment
import { MeiliSearch } from 'meilisearch'

;(async () => {
  const client = new MeiliSearch({
    host: 'http://127.0.0.1:7700',
    apiKey: 'masterKey',
  })

  // An index is where the documents are stored.
  const index = client.index('movies')

  const documents = [
      { id: 1, title: 'Carol', genres: ['Romance', 'Drama'] },
      { id: 2, title: 'Wonder Woman', genres: ['Action', 'Adventure'] },
      { id: 3, title: 'Life of Pi', genres: ['Adventure', 'Drama'] },
      { id: 4, title: 'Mad Max: Fury Road', genres: ['Adventure', 'Science Fiction'] },
      { id: 5, title: 'Moana', genres: ['Fantasy', 'Action']},
      { id: 6, title: 'Philadelphia', genres: ['Drama'] },
  ]

  // If the index 'movies' does not exist, Meilisearch creates it when you first add the documents.
  let response = await index.addDocuments(documents)

  console.log(response) // => { "uid": 0 }
})()

With the uid, you can check the status (enqueued, processing, succeeded or failed) of your documents addition using the task.

Basic Search

// Meilisearch is typo-tolerant:
const search = await index.search('philoudelphia')
console.log(search)

Output:

{
  "hits": [
    {
      "id": "6",
      "title": "Philadelphia",
      "genres": ["Drama"]
    }
  ],
  "offset": 0,
  "limit": 20,
  "estimatedTotalHits": 1,
  "processingTimeMs": 1,
  "query": "philoudelphia"
}

Custom Search

All the supported options are described in the search parameters section of the documentation.

await index.search(
  'wonder',
  {
    attributesToHighlight: ['*']
  }
)

{
  "hits": [
    {
      "id": 2,
      "title": "Wonder Woman",
      "genres": ["Action", "Adventure"],
      "_formatted": {
        "id": 2,
        "title": "<em>Wonder</em> Woman",
        "genres": ["Action", "Adventure"]
      }
    }
  ],
  "offset": 0,
  "limit": 20,
  "estimatedTotalHits": 1,
  "processingTimeMs": 0,
  "query": "wonder"
}

Custom Search With Filters

If you want to enable filtering, you must add your attributes to the filterableAttributes index setting.

await index.updateAttributesForFaceting([
    'id',
    'genres'
  ])

You only need to perform this operation once.

Note that Meilisearch will rebuild your index whenever you update filterableAttributes. Depending on the size of your dataset, this might take time. You can track the process using the tasks).

Then, you can perform the search:

await index.search(
  'wonder',
  {
    filter: ['id > 1 AND genres = Action']
  }
)

{
  "hits": [
    {
      "id": 2,
      "title": "Wonder Woman",
      "genres": ["Action","Adventure"]
    }
  ],
  "offset": 0,
  "limit": 20,
  "estimatedTotalHits": 1,
  "processingTimeMs": 0,
  "query": "wonder"
}

Placeholder Search

Placeholder search makes it possible to receive hits based on your parameters without having any query (q). To enable faceted search on your dataset you need to add genres in the settings.

await index.search(
  '',
  {
    filter: ['genres = fantasy'],
    facets: ['genres']
  }
)

{
  "hits": [
    {
      "id": 2,
      "title": "Wonder Woman",
      "genres": ["Action","Adventure"]
    },
    {
      "id": 5,
      "title": "Moana",
      "genres": ["Fantasy","Action"]
    }
  ],
  "offset": 0,
  "limit": 20,
  "estimatedTotalHits": 2,
  "processingTimeMs": 0,
  "query": "",
  "facetDistribution": {
    "genres": {
      "Action": 2,
      "Fantasy": 1,
      "Adventure": 1
    }
  }
}

Abortable Search

You can abort a pending search request by providing an AbortSignal to the request.

const controller = new AbortController()

index
  .search('wonder', {}, {
    signal: controller.signal,
  })
  .then((response) => {
    /** ... */
  })
  .catch((e) => {
    /** Catch AbortError here. */
  })

controller.abort()

🤖 Compatibility with Meilisearch

This package only guarantees the compatibility with the version v0.28.0 of Meilisearch.

💡 Learn More

The following sections may interest you:

• Manipulate documents: see the API references or read more about documents.
• Search: see the API references or follow our guide on search parameters.
• Manage the indexes: see the API references or read more about indexes.
• Configure the index settings: see the API references or follow our guide on settings parameters.

This repository also contains more examples.

⚙️ Development Workflow and Contributing

Any new contribution is more than welcome to this project!

If you want to know more about the development workflow or want to contribute, please visit our contributing guidelines for detailed instructions!

📜 API Resources

Search

• Make a search request:

client.index<T>('xxx').search(query: string, options: SearchParams = {}, config?: Partial<Request>): Promise<SearchResponse<T>>

• Make a search request using the GET method (slower than the search method):

client.index<T>('xxx').searchGet(query: string, options: SearchParams = {}, config?: Partial<Request>): Promise<SearchResponse<T>>

Documents

• Add or replace multiple documents:

index.addDocuments(documents: Document<T>[]): Promise<EnqueuedTask>

• Add or replace multiple documents in batches:

index.addDocumentsInBatches(documents: Document<T>[], batchSize = 1000): Promise<EnqueuedTask[]>

• Add or update multiple documents:

index.updateDocuments(documents: Array<Document<Partial<T>>>): Promise<EnqueuedTask>

• Add or update multiple documents in batches:

index.updateDocumentsInBatches(documents: Array<Document<Partial<T>>>, batchSize = 1000): Promise<EnqueuedTask[]>

• Get Documents:

index.getDocuments(parameters: DocumentsQuery = {}): Promise<DocumentsResults<T>>>

• Get one document:

index.getDocument(documentId: string): Promise<Document<T>>

• Delete one document:

index.deleteDocument(documentId: string | number): Promise<EnqueuedTask>

• Delete multiple documents:

index.deleteDocuments(documentsIds: string[] | number[]): Promise<EnqueuedTask>

• Delete all documents:

index.deleteAllDocuments(): Promise<Types.EnqueuedTask>

Tasks

• Get all tasks

  client.getTasks(parameters: TasksQuery): Promise<TasksResults>

• Get one task

  client.getTask(uid: number): Promise<Task>

• Get all tasks of an index

  index.getTasks(parameters: TasksQuery): Promise<TasksResults>

• Get one task of an index

  index.getTask(uid: number): Promise<Task>

• Wait for one task:

  client.waitForTask(uid: number, { timeOutMs?: number, intervalMs?: number }): Promise<Task>

  With an index instance: index.waitForTask(uid: number, { timeOutMs?: number, intervalMs?: number }): Promise<Task>

• Wait for multiple tasks: client.waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Task[]>

  With an index instance: index.waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Task[]>

Indexes

• Get all indexes as Index instances:

client.getIndexes(parameters: IndexesQuery): Promise<IndexesResults<Index[]>>

• Get all indexes:

client.getRawIndexes(parameters: IndexesQuery): Promise<IndexesResults<IndexObject[]>>

• Create a new index:

client.createIndex<T>(uid: string, options?: IndexOptions): Promise<EnqueuedTask>

• Create a local reference to an index:

client.index<T>(uid: string): Index<T>

• Get an index instance completed with information fetched from Meilisearch: client.getIndex<T>(uid: string): Promise<Index<T>>

• Get the raw index JSON response from Meilisearch: client.getRawIndex(uid: string): Promise<IndexObject>

• Get an object with information about the index: index.getRawInfo(): Promise<IndexObject>

• Update Index:

Using the client client.updateIndex(uid: string, options: IndexOptions): Promise<EnqueuedTask>

Using the index object: index.update(data: IndexOptions): Promise<EnqueuedTask>

• Delete Index:

Using the client client.deleteIndex(uid): Promise<void>

Using the index object: index.delete(): Promise<void>

• Get specific index stats:

index.getStats(): Promise<IndexStats>

• Return Index instance with updated information:

index.fetchInfo(): Promise<Index>

• Get Primary Key of an Index:

index.fetchPrimaryKey(): Promise<string | undefined>

Settings

• Get settings:

index.getSettings(): Promise<Settings>

• Update settings:

index.updateSettings(settings: Settings): Promise<EnqueuedTask>

• Reset settings:

index.resetSettings(): Promise<EnqueuedTask>

Synonyms

• Get synonyms:

index.getSynonyms(): Promise<object>

• Update synonyms:

index.updateSynonyms(synonyms: Synonyms): Promise<EnqueuedTask>

• Reset synonyms:

index.resetSynonyms(): Promise<EnqueuedTask>

Stop-words

• Get Stop Words: index.getStopWords(): Promise<string[]>

• Update Stop Words: index.updateStopWords(stopWords: string[] | null ): Promise<EnqueuedTask>

• Reset Stop Words: index.resetStopWords(): Promise<EnqueuedTask>

Ranking rules

• Get Ranking Rules: index.getRankingRules(): Promise<string[]>

• Update Ranking Rules: index.updateRankingRules(rankingRules: string[] | null): Promise<EnqueuedTask>

• Reset Ranking Rules: index.resetRankingRules(): Promise<EnqueuedTask>

Distinct Attribute

• Get Distinct Attribute: index.getDistinctAttribute(): Promise<string | void>

• Update Distinct Attribute: index.updateDistinctAttribute(distinctAttribute: string | null): Promise<EnqueuedTask>

• Reset Distinct Attribute: index.resetDistinctAttribute(): Promise<EnqueuedTask>

Searchable Attributes

• Get Searchable Attributes: index.getSearchableAttributes(): Promise<string[]>

• Update Searchable Attributes: index.updateSearchableAttributes(searchableAttributes: string[] | null): Promise<EnqueuedTask>

• Reset Searchable Attributes: index.resetSearchableAttributes(): Promise<EnqueuedTask>

Displayed Attributes

• Get Displayed Attributes: index.getDisplayedAttributes(): Promise<string[]>

• Update Displayed Attributes: index.updateDisplayedAttributes(displayedAttributes: string[] | null): Promise<EnqueuedTask>

• Reset Displayed Attributes: index.resetDisplayedAttributes(): Promise<EnqueuedTask>

Filterable Attributes

• Get Filterable Attributes: index.getFilterableAttributes(): Promise<string[]>

• Update Filterable Attributes: index.updateFilterableAttributes(filterableAttributes: string[] | null): Promise<EnqueuedTask>

• Reset Filterable Attributes: index.resetFilterableAttributes(): Promise<EnqueuedTask>

Sortable Attributes

• Get Sortable Attributes: index.getSortableAttributes(): Promise<string[]>

• Update Sortable Attributes: index.updateSortableAttributes(sortableAttributes: string[] | null): Promise<EnqueuedTask>

• Reset Sortable Attributes: index.resetSortableAttributes(): Promise<EnqueuedTask>

Typo Tolerance

• Get Typo Tolerance: index.getTypoTolerance(): Promise<TypoTolerance>

• Update Typo Tolerance: index.updateTypoTolerance(typoTolerance: TypoTolerance | null): Promise<EnqueuedTask>

• Reset Typo Tolerance: index.resetTypoTolerance(): Promise<EnqueuedTask>

Keys

• Get keys:

client.getKeys(parameters: KeysQuery): Promise<KeysResults>

• Get one key:

client.getKey(keyOrUid: string): Promise<Key>

• Create a key:

client.createKey(options: KeyCreation): Promise<Key>

• Update a key:

client.updateKey(keyOrUid: string, options: KeyUpdate): Promise<Key>

• Delete a key:

client.deleteKey(keyOrUid: string): Promise<void>

isHealthy

• Return true or false depending on the health of the server:

client.isHealthy(): Promise<boolean>

Health

• Check if the server is healthy:

client.health(): Promise<Health>

Stats

• Get database stats:

client.getStats(): Promise<Stats>

Version

• Get binary version:

client.getVersion(): Promise<Version>

Dumps

• Trigger a dump creation process:

client.createDump(): Promise<EnqueuedTask>

---

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. If you want to contribute, make suggestions, or just know what's going on right now, visit us in the integration-guides repository.