---
title: "@adonia/meilisearch API"
image: "https://adonia.pages.dev/og.png"
version: "next"
---

> Documentation Index
> Fetch the complete documentation index at: https://adonia.pages.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# @adonia/meilisearch API

<!-- Generated by docs/site/scripts/generate_api.ts. Do not edit. -->

Canonical inventory of every public subpath and TypeScript export in `@adonia/meilisearch`.

## `@adonia/meilisearch`

| Export | Kind | Source | Summary |
| --- | --- | --- | --- |
| `attachSearchSync` | function | `packages/meilisearch/src/indexer.ts:866` | Registers Lucid `afterSave` and `afterDelete` equivalents that keep a configured `MeilisearchIndexer` synchronized incrementally. |
| `defineMeilisearchDriver` | function | `packages/meilisearch/src/index.ts:119` | Creates a public-contract-compatible Meilisearch search driver. |
| `MaybePromise` | type-only type | `packages/meilisearch/src/client.ts:4` | A value that may be produced synchronously or asynchronously. |
| `MEILISEARCH_REINDEX_BINDING` | constant | `packages/meilisearch/src/reindex_command.ts:8` | IoC binding resolved by `SearchReindexCommand`. |
| `MeilisearchAdapterError` | class | `packages/meilisearch/src/indexer.ts:127` | Stable base error for failures produced by the adapter itself. |
| `MeilisearchClientLike` | type-only interface | `packages/meilisearch/src/client.ts:88` | Minimal Meilisearch client surface consumed by the adapter. |
| `MeilisearchDocument` | type-only type | `packages/meilisearch/src/indexer.ts:25` | A document accepted by Meilisearch. |
| `MeilisearchDriverOptions` | type-only interface | `packages/meilisearch/src/index.ts:67` | Configuration for `defineMeilisearchDriver`. |
| `MeilisearchFullReindexOptions` | type-only interface | `packages/meilisearch/src/indexer.ts:48` | Options controlling a full resource reindex. |
| `MeilisearchFullReindexResult` | type-only interface | `packages/meilisearch/src/indexer.ts:68` | Result of a completed full reindex. |
| `MeilisearchHealthResult` | type-only interface | `packages/meilisearch/src/indexer.ts:76` | Reachability and index statistics reported by `MeilisearchIndexer.health`. |
| `MeilisearchIndexer` | class | `packages/meilisearch/src/indexer.ts:265` | Incremental indexing, settings management, task polling, and zero-downtime resource rebuilds over a structural Meilisearch client boundary. |
| `MeilisearchIndexerOptions` | type-only interface | `packages/meilisearch/src/indexer.ts:101` | Configuration for `MeilisearchIndexer`. |
| `MeilisearchIndexLike` | type-only interface | `packages/meilisearch/src/client.ts:66` | Minimal Meilisearch index surface consumed by search and indexing. |
| `MeilisearchIndexManyOptions` | type-only interface | `packages/meilisearch/src/indexer.ts:42` | Options for a batched incremental indexing call. |
| `MeilisearchIndexManyResult` | type-only interface | `packages/meilisearch/src/indexer.ts:58` | Result of one batched indexing operation. |
| `MeilisearchIndexName` | type-only type | `packages/meilisearch/src/client.ts:127` | Static or request-aware Meilisearch index uid resolver. |
| `MeilisearchIndexStats` | type-only interface | `packages/meilisearch/src/client.ts:25` | Index statistics returned by Meilisearch. |
| `MeilisearchInvalidRecordError` | class | `packages/meilisearch/src/indexer.ts:140` | Raised when a record has no usable string or numeric primary key. |
| `MeilisearchOperationContext` | type-only interface | `packages/meilisearch/src/indexer.ts:28` | Request-independent metadata for an indexing operation. |
| `MeilisearchRecordSerializer` | type-only type | `packages/meilisearch/src/indexer.ts:95` | Converts a Lucid record or application object into a Meilisearch document. |
| `MeilisearchRecordSource` | type-only type | `packages/meilisearch/src/indexer.ts:90` | Source used by a full reindex to enumerate resource records. |
| `MeilisearchReindexCommandContext` | type-only interface | `packages/meilisearch/src/reindex_command.ts:11` | Application-owned dependencies consumed by the reindex command scaffold. |
| `MeilisearchRequestContext` | type-only interface | `packages/meilisearch/src/client.ts:113` | Request metadata supplied to dynamic index names and search options. |
| `MeilisearchResource` | type-only type | `packages/meilisearch/src/indexer.ts:22` | A resource instance or its concrete constructor. |
| `MeilisearchRetryOptions` | type-only interface | `packages/meilisearch/src/client.ts:137` | Bounded exponential-backoff policy for retryable 5xx responses. |
| `MeilisearchSearchOptions` | type-only type | `packages/meilisearch/src/client.ts:132` | Static or request-aware options forwarded to `index.search`. |
| `MeilisearchSearchResponse` | type-only interface | `packages/meilisearch/src/client.ts:7` | Minimal response shape returned by a Meilisearch index search. |
| `MeilisearchSettings` | type-only interface | `packages/meilisearch/src/client.ts:50` | Declarative settings managed by `MeilisearchIndexer.updateSettings`. |
| `MeilisearchTask` | type-only interface | `packages/meilisearch/src/client.ts:13` | An enqueued or completed Meilisearch task. |
| `MeilisearchTaskFailedError` | class | `packages/meilisearch/src/indexer.ts:159` | Raised when a Meilisearch task reports failure or cancellation. |
| `MeilisearchTaskPollingOptions` | type-only interface | `packages/meilisearch/src/client.ts:147` | Task polling policy used by index lifecycle operations. |
| `MeilisearchTaskTimeoutError` | class | `packages/meilisearch/src/indexer.ts:176` | Raised when a Meilisearch task does not finish before its deadline. |
| `MeilisearchTypoToleranceSettings` | type-only interface | `packages/meilisearch/src/client.ts:33` | Declarative Meilisearch typo-tolerance settings. |
| `MeilisearchUnsupportedClientError` | class | `packages/meilisearch/src/indexer.ts:148` | Raised when a configured client lacks a lifecycle method. |
| `normalizeMeilisearchHits` | function | `packages/meilisearch/src/index.ts:88` | Normalizes remote hits into unique database ids. |
| `SearchReindexCommand` | class | `packages/meilisearch/src/reindex_command.ts:24` | Ace command scaffold for `node ace adonia:search:reindex`. |
| `SearchSyncModelLike` | type-only interface | `packages/meilisearch/src/indexer.ts:855` | Static Lucid hook surface consumed by `attachSearchSync`. |

Source: https://adonia.pages.dev/reference/api/meilisearch/index.mdx