README
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,
"nbHits": 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,
"nbHits": 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,
"nbHits": 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'],
facetsDistribution: ['genres']
}
)
{
"hits": [
{
"id": 2,
"title": "Wonder Woman",
"genres": ["Action","Adventure"]
},
{
"id": 5,
"title": "Moana",
"genres": ["Fantasy","Action"]
}
],
"offset": 0,
"limit": 20,
"nbHits": 2,
"processingTimeMs": 0,
"query": "",
"facetsDistribution": {
"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.25.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
client.index<T>('xxx').search(query: string, options: SearchParams = {}, config?: Partial<Request>): Promise<SearchResponse<T>>
client.index<T>('xxx').searchGet(query: string, options: SearchParams = {}, config?: Partial<Request>): Promise<SearchResponse<T>>
Documents
index.addDocuments(documents: Document<T>[]): Promise<EnqueuedTask>
index.addDocumentsInBatches(documents: Document<T>[], batchSize = 1000): Promise<EnqueuedTask[]>
index.updateDocuments(documents: Document<T>[]): Promise<EnqueuedTask>
index.updateDocumentsInBatches(documents: Document<T>[], batchSize = 1000): Promise<EnqueuedTask[]>
index.getDocuments(params: getDocumentsParams): Promise<Document<T>[]>
index.getDocument(documentId: string): Promise<Document<T>>
index.deleteDocument(documentId: string | number): Promise<EnqueuedTask>
index.deleteDocuments(documentsIds: string[] | number[]): Promise<EnqueuedTask>
index.deleteAllDocuments(): Promise<Types.EnqueuedTask>
Tasks
Task list:
client.getTasks(): Promise<Result<Task[]>>
One task:
client.getTask(uid: number): Promise<Task>
Task list:
index.getTasks(): Promise<Result<Task[]>>
One task:
index.getTask(uid: number): Promise<Task>
- Wait for one task:
Using de client:
client.waitForTask(uid: number, { timeOutMs?: number, intervalMs?: number }): Promise<Task>
Using the index:
index.waitForTask(uid: number, { timeOutMs?: number, intervalMs?: number }): Promise<Task>
- Wait for multiple tasks:
Using the client:
client.waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Result<Task[]>>
Using the index:
index.waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise<Result<Task[]>>
Indexes
client.getIndexes(): Promise<IndexResponse[]>
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<IndexResponse>
Get an object with information about the index:
index.getRawInfo(): Promise<IndexResponse>
Using the client
client.updateIndex(uid: string, options: IndexOptions): Promise<EnqueuedTask>
Using the index object:
index.update(data: IndexOptions): Promise<EnqueuedTask>
Using the client
client.deleteIndex(uid): Promise<void>
Using the index object:
index.delete(): Promise<void>
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
index.getSettings(): Promise<Settings>
index.updateSettings(settings: Settings): Promise<EnqueuedTask>
index.resetSettings(): Promise<EnqueuedTask>
Synonyms
index.getSynonyms(): Promise<object>
index.updateSynonyms(synonyms: Synonyms): Promise<EnqueuedTask>
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>
Keys
client.getKeys(): Promise<Result<Key[]>>
client.getKey(key: string): Promise<Key>
client.createKey(options: KeyPayload): Promise<Key>
client.updateKey(key: string, options: KeyPayload): Promise<Key>
client.deleteKey(key: string): Promise<void>
isHealthy
client.isHealthy(): Promise<boolean>
Health
client.health(): Promise<Health>
Stats
client.getStats(): Promise<Stats>
Version
client.getVersion(): Promise<Version>
Dumps
client.createDump(): Promise<Types.EnqueuedDump>
client.getDumpStatus(dumpUid: string): Promise<Types.EnqueuedDump>
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.