Package Health Score

87 / 100

security
No known security issues
popularity
Recognized
maintenance
Healthy
community
Active

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

Version			Vulnerabilities	License Risk
0.46.0	\|	12/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.45.0	\|	10/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.44.1	\|	10/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.43.0	\|	10/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.42.0	\|	08/2024	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

MIT

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Recognized

Weekly Downloads (73,404)

GitHub Stars: 750
Forks: 89
Contributors: 80

Direct Usage Popularity

The npm package meilisearch receives a total of 73,404 downloads a week. As such, we scored meilisearch popularity level to be Recognized.

Based on project statistics from the GitHub repository for the npm package meilisearch, we found that it has been starred 750 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Active

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 80
Funding: No

With more than 10 contributors for the meilisearch repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like meilisearch is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Healthy

Commit Frequency

Open Issues: 13
Open PR: 8
Last Release: 23 days ago
Last Commit: 23 days ago

Further analysis of the maintenance status of meilisearch based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Healthy.

We found that meilisearch demonstrates a positive version release cadence with at least one new version released in the past 3 months.

As a healthy sign for on-going project maintenance, we found that the GitHub repository had at least 1 pull request or issue interacted with by the community.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 5 years
Dependencies: 0 Direct
Versions: 98
Install Size: 722 kB
Dist-tags: 2
# of Files: 66
Maintainers: 4
TS Typings: Yes

meilisearch has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Meilisearch-JavaScript

Meilisearch JavaScript

Meilisearch | Meilisearch Cloud | Documentation | Discord | 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. Learn more about Meilisearch.

📖 Documentation

This readme and Meilisearch JS documentation website contains all the information you need to start using this Meilisearch SDK.

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.

⚡ Supercharge your Meilisearch experience

Say goodbye to server deployment and manual updates with Meilisearch Cloud. Get started with a 14-day free trial! No credit card required.

🔧 Installation

We recommend installing meilisearch-js in your project with your package manager of choice.

npm install meilisearch

meilisearch-js officially supports node versions >= 14 and <= 18.

Instead of using a package manager, you may also import the library directly into your HTML via a CDN.

Run Meilisearch

To use one of our SDKs, you must first have a running Meilisearch instance. Consult our documentation for instructions on how to download and launch Meilisearch.

Import

After installing meilisearch-js, you must import it into your application. There are many ways of doing that depending on your development environment.

`import` syntax

Usage in an ES module environment:

import { MeiliSearch } from 'meilisearch'

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

`


#### `require` syntax 

Usage in a back-end node.js or another environment supporting CommonJS modules:

```javascript
const { MeiliSearch } = require('meilisearch')

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

React Native

To use meilisearch-js with React Native, you must also install react-native-url-polyfill.

Deno

Usage in a Deno environment:

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

const client = new MeiliSearch({
  host: 'https://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 () =&gt; {
  const client = new MeiliSearch({
    host: 'https://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) // =&gt; { "uid": 0 }
})()

Tasks such as document addition always return a unique identifier. You can use this identifier taskUid to check the status (enqueued, canceled, processing, succeeded or failed) of a 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"
}

Using search parameters

meilisearch-js supports all search parameters described in our main documentation website.

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

To enable filtering, you must first add your attributes to the filterableAttributes index setting.

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

You only need to perform this operation once per index.

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

After you configured filterableAttributes, you can use the filter search parameter to refine your search:

await index.search(
  'wonder',
  {
    filter: ['id &gt; 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). For example, in a movies database you can run an empty query to receive all results filtered by genre.

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

Note that to enable faceted search on your dataset you need to add genres to the filterableAttributes index setting. For more information on filtering and faceting, consult our documentation settings.

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) =&gt; {
    /** ... */
  })
  .catch((e) =&gt; {
    /** Catch AbortError here. */
  })

controller.abort()

Using Meilisearch behind a proxy

Custom request config

You can provide a custom request configuration. for example, with custom headers.

const client: MeiliSearch = new MeiliSearch({
  host: 'https://localhost:3000/api/meilisearch/proxy',
  requestConfig: {
    headers: {
      Authorization: AUTH_TOKEN
    },
    // OR
    credentials: 'include'
  }
})

Custom http client

You can use your own HTTP client, for example, with axios.

const client: MeiliSearch = new MeiliSearch({
  host: 'https://localhost:3000/api/meilisearch/proxy',
  httpClient: async (url, opts) =&gt; {
    const response = await $axios.request({
      url,
      data: opts?.body,
      headers: opts?.headers,
      method: (opts?.method?.toLocaleUpperCase() as Method) ?? 'GET'
    })

    return response.data
  }
})

🤖 Compatibility with Meilisearch

This package guarantees compatibility with version v1.x of Meilisearch, but some features may not be present. Please check the issues for more info.

💡 Learn more

The following sections in our main documentation website 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.

⚙️ 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.

📜 API resources

Search

Make a search request

client.index('xxx').search(query: string, options: SearchParams = {}, config?: Partial): Promise&gt;

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

client.index('xxx').searchGet(query: string, options: SearchParams = {}, config?: Partial): Promise&gt;

Multi Search

Make multiple search requests

client.multiSearch(queries?: MultiSearchParams, config?: Partial): Promise&gt;&gt;

multiSearch uses the POST method when performing its request to Meilisearch.

Search For Facet Values

Search for facet values

client.index('myIndex').searchForFacetValues(params: SearchForFacetValuesParams, config?: Partial): Promise

Documents

Add or replace multiple documents

client.index('myIndex').addDocuments(documents: Document[]): Promise

Add or replace multiple documents in string format

client.index('myIndex').addDocumentsFromString(documents: string, contentType: ContentType, queryParams: RawDocumentAdditionOptions): Promise

Add or replace multiple documents in batches

client.index('myIndex').addDocumentsInBatches(documents: Document[], batchSize = 1000): Promise

Add or update multiple documents

client.index('myIndex').updateDocuments(documents: Array&gt;&gt;): Promise

Add or update multiple documents in string format

client.index('myIndex').updateDocumentsFromString(documents: string, contentType: ContentType, queryParams: RawDocumentAdditionOptions): Promise

Add or update multiple documents in batches

client.index('myIndex').updateDocumentsInBatches(documents: Array&gt;&gt;, batchSize = 1000): Promise

Get Documents

client.index.getDocuments(parameters: DocumentsQuery = {}): Promise&gt;&gt;

Get one document

client.index('myIndex').getDocument(documentId: string): Promise&gt;

Delete one document

client.index('myIndex').deleteDocument(documentId: string | number): Promise

Delete multiple documents

client.index('myIndex').deleteDocuments(params: DocumentsDeletionQuery | DocumentsIds): Promise

Delete all documents

client.index('myIndex').deleteAllDocuments(): Promise

Tasks

Get all tasks

client.getTasks(parameters: TasksQuery): Promise

Get one task

client.getTask(uid: number): Promise

Delete tasks

client.deleteTasks(parameters: DeleteTasksQuery = {}): Promise

Cancel tasks

client.cancelTasks(parameters: CancelTasksQuery = {}): Promise

Get all tasks of an index

client.index('myIndex').getTasks(parameters: TasksQuery): Promise

Get one task of an index

client.index('myIndex').getTask(uid: number): Promise

Wait for one task

Using the client

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

Using the index

client.index('myIndex').waitForTask(uid: number, { timeOutMs?: number, intervalMs?: number }): Promise

Wait for multiple tasks

Using the client

client.waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise

Using the index

client.index('myIndex').waitForTasks(uids: number[], { timeOutMs?: number, intervalMs?: number }): Promise

Indexes

Get all indexes in Index instances

client.getIndexes(parameters: IndexesQuery): Promise&gt;

Get all indexes

client.getRawIndexes(parameters: IndexesQuery): Promise&gt;

Create a new index

client.createIndex(uid: string, options?: IndexOptions): Promise

Create a local reference to an index

client.index(uid: string): Index

Get an index instance completed with information fetched from Meilisearch

client.getIndex(uid: string): Promise&gt;

Get the raw index JSON response from Meilisearch

client.getRawIndex(uid: string): Promise

Get an object with information about the index

client.index('myIndex').getRawInfo(): Promise

Update Index

Using the client

client.updateIndex(uid: string, options: IndexOptions): Promise

Using the index object

client.index('myIndex').update(data: IndexOptions): Promise

Delete index

Using the client

client.deleteIndex(uid): Promise

Using the index object

client.index('myIndex').delete(): Promise

Get specific index stats

client.index('myIndex').getStats(): Promise

Return Index instance with updated information

client.index('myIndex').fetchInfo(): Promise

Get Primary Key of an Index

client.index('myIndex').fetchPrimaryKey(): Promise

Swap two indexes

client.swapIndexes(params: SwapIndexesParams): Promise

Settings

Get settings

client.index('myIndex').getSettings(): Promise

Update settings

client.index('myIndex').updateSettings(settings: Settings): Promise

Reset settings

client.index('myIndex').resetSettings(): Promise

Pagination Settings

Get pagination

client.index('myIndex').getPagination(): Promise

Update pagination

client.index('myIndex').updatePagination(pagination: PaginationSettings): Promise

Reset pagination

client.index('myIndex').resetPagination(): Promise

Synonyms

Get synonyms

client.index('myIndex').getSynonyms(): Promise

Update synonyms

client.index('myIndex').updateSynonyms(synonyms: Synonyms): Promise

Reset synonyms

client.index('myIndex').resetSynonyms(): Promise

Stop words

Get stop words

client.index('myIndex').getStopWords(): Promise

Update stop words

client.index('myIndex').updateStopWords(stopWords: string[] | null ): Promise

Reset stop words

client.index('myIndex').resetStopWords(): Promise

Ranking rules

Get ranking rules

client.index('myIndex').getRankingRules(): Promise

Update ranking rules

client.index('myIndex').updateRankingRules(rankingRules: string[] | null): Promise

Reset ranking rules

client.index('myIndex').resetRankingRules(): Promise

Distinct Attribute

Get distinct attribute

client.index('myIndex').getDistinctAttribute(): Promise

Update distinct attribute

client.index('myIndex').updateDistinctAttribute(distinctAttribute: string | null): Promise

Reset distinct attribute

client.index('myIndex').resetDistinctAttribute(): Promise

Searchable attributes

Get searchable attributes

client.index('myIndex').getSearchableAttributes(): Promise

Update searchable attributes

client.index('myIndex').updateSearchableAttributes(searchableAttributes: string[] | null): Promise

Reset searchable attributes

client.index('myIndex').resetSearchableAttributes(): Promise

Displayed attributes

Get displayed attributes

client.index('myIndex').getDisplayedAttributes(): Promise

Update displayed attributes

client.index('myIndex').updateDisplayedAttributes(displayedAttributes: string[] | null): Promise

Reset displayed attributes

client.index('myIndex').resetDisplayedAttributes(): Promise

Filterable attributes

Get filterable attributes

client.index('myIndex').getFilterableAttributes(): Promise

Update filterable attributes

client.index('myIndex').updateFilterableAttributes(filterableAttributes: string[] | null): Promise

Reset filterable attributes

client.index('myIndex').resetFilterableAttributes(): Promise

Sortable attributes

Get sortable attributes

client.index('myIndex').getSortableAttributes(): Promise

Update sortable attributes

client.index('myIndex').updateSortableAttributes(sortableAttributes: string[] | null): Promise

Reset sortable attributes

client.index('myIndex').resetSortableAttributes(): Promise

Faceting

Get faceting

client.index('myIndex').getFaceting(): Promise

Update faceting

client.index('myIndex').updateFaceting(faceting: Faceting): Promise

Reset faceting

client.index('myIndex').resetFaceting(): Promise

Typo tolerance

Get typo tolerance

client.index('myIndex').getTypoTolerance(): Promise

Update typo tolerance

client.index('myIndex').updateTypoTolerance(typoTolerance: TypoTolerance | null): Promise

Reset typo tolerance

client.index('myIndex').resetTypoTolerance(): Promise

Separator tokens

Get separator tokens

client.index('myIndex').getSeparatorTokens(): Promise

Update separator tokens

client.index('myIndex').updateSeparatorTokens(separatorTokens: SeparatorTokens | null): Promise

Reset separator tokens

client.index('myIndex').resetSeparatorTokens(): Promise

Non Separator tokens

Get non separator tokens

client.index('myIndex').getNonSeparatorTokens(): Promise

Update non separator tokens

client.index('myIndex').updateNonSeparatorTokens(nonSeparatorTokens: NonSeparatorTokens | null): Promise

Reset non separator tokens

client.index('myIndex').resetNonSeparatorTokens(): Promise

Dictionary

Get dictionary

client.index('myIndex').getDictionary(): Promise

Update dictionary

client.index('myIndex').updateDictionary(dictionary: Dictionary | null): Promise

Reset dictionary

client.index('myIndex').resetDictionary(): Promise

Proximity Precision

Get proximity precision

client.index('myIndex').getProximityPrecision(): Promise

Update proximity precision

client.index('myIndex').updateProximityPrecision(proximityPrecision: ProximityPrecision): Promise

Reset proximity precision

client.index('myIndex').resetProximityPrecision(): Promise

Embedders

⚠️ This feature is experimental. Activate the vectorStore experimental feature to use it

Get embedders

client.index('myIndex').getEmbedders(): Promise

Update embedders

client.index('myIndex').updateEmbedders(embedders: Embedders): Promise

Reset embedders

client.index('myIndex').resetEmbedders(): Promise

SearchCutoffMs

Get SearchCutoffMs

client.index('myIndex').getSearchCutoffMs(): Promise

Update SearchCutoffMs

client.index('myIndex').updateSearchCutoffMs(searchCutoffMs: SearchCutoffMs): Promise

Reset SearchCutoffMs

client.index('myIndex').resetSearchCutoffMs(): Promise

Keys

Get keys

client.getKeys(parameters: KeysQuery): Promise

Get one key

client.getKey(keyOrUid: string): Promise

Create a key

client.createKey(options: KeyCreation): Promise

Update a key

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

Delete a key

client.deleteKey(keyOrUid: string): Promise

`isHealthy`

Return `true` or `false` depending on the health of the server

client.isHealthy(): Promise

Health

Check if the server is healthy

client.health(): Promise

Stats

Get database stats

client.getStats(): Promise

Version

Get binary version

client.getVersion(): Promise

Dumps

Trigger a dump creation process

client.createDump(): Promise

Snapshots

Trigger a snapshot on-demand process

client.createSnapshot(): Promise

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.

FAQs

What is meilisearch?

The Meilisearch JS client for Node.js and the browser. Visit Snyk Advisor to see a full health score report for meilisearch, including popularity, security, maintenance & community analysis.

Is meilisearch popular?

The npm package meilisearch receives a total of 73,404 weekly downloads. As such, meilisearch popularity was classified as a recognized. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is meilisearch well maintained?

We found that meilisearch demonstrated a healthy version release cadence and project activity. It has a community of 80 open source contributors collaborating on the project. See the full package health analysis to learn more about the package maintenance status.

Is meilisearch safe to use?

The npm package meilisearch was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 3 December-2024, at 00:11 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP

Package Health Score

Explore Similar Packages

Security and license risk for significant versions

Is your project affected by vulnerabilities?

Weekly Downloads (73,404)

Direct Usage Popularity

Embed Package Health Score Badge

Commit Frequency

Keep your project healthy

Check your package.json

Snyk Vulnerability Scanner

Readme

Meilisearch JavaScript

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

Table of Contents

📖 Documentation

⚡ Supercharge your Meilisearch experience

🔧 Installation

Run Meilisearch

Import

import syntax

`

React Native

Deno

🎬 Getting started

Add documents

Basic search

Using search parameters

Custom search with filters

Placeholder search

Abortable search

Using Meilisearch behind a proxy

Custom request config

Custom http client

🤖 Compatibility with Meilisearch

💡 Learn more

⚙️ Contributing

📜 API resources

Search

Multi Search

Search For Facet Values

Documents

Tasks

Wait for one task

Using the client

Using the index

Wait for multiple tasks

Using the client

Using the index

Indexes

Create a local reference to an index

Using the client

Using the index object

Using the client

Using the index object

Return Index instance with updated information

Get Primary Key of an Index

Swap two indexes

Settings

Pagination Settings

Synonyms

Stop words

Ranking rules

Distinct Attribute

Searchable attributes

Displayed attributes

Filterable attributes

Sortable attributes

Faceting

Typo tolerance

Separator tokens

Non Separator tokens

`import` syntax