Class MeilisearchStore

constructor

• new MeilisearchStore(options: MeilisearchStoreOptions): MeilisearchStore

  Parameters

  • options: MeilisearchStoreOptions

  Returns MeilisearchStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): any

  Returns the underlying meilisearch client for anything not wrapped here.

  Returns any

createIndex

• createIndex(uid: string, options?: Record<string, unknown>): Promise<any>

  Create an index by uid, optionally specifying its primary key via options.

  Parameters

  • uid: string
  • Optionaloptions: Record<string, unknown>

  Returns Promise<any>

deleteIndex

• deleteIndex(uid: string): Promise<any>

  Delete an index by uid.

  Parameters

  • uid: string

  Returns Promise<any>

addDocuments

• addDocuments(
      index: string,
      documents: Record<string, unknown>[],
      options?: Record<string, unknown>,
  ): Promise<any>

  Add (or replace) documents in an index. Returns the enqueued task.

  Parameters

  • index: string
  • documents: Record<string, unknown>[]
  • Optionaloptions: Record<string, unknown>

  Returns Promise<any>

search

• search<T = Record<string, unknown>>(
      index: string,
      query: string,
      options?: Record<string, unknown>,
  ): Promise<T[]>

  Run a search against an index and return the hits array from the response.

  Type Parameters

  • T = Record<string, unknown>

  Parameters

  • index: string
  • query: string
  • Optionaloptions: Record<string, unknown>

  Returns Promise<T[]>

getDocument

• getDocument<T = Record<string, unknown>>(
      index: string,
      id: string | number,
  ): Promise<T>

  Get a single document by its primary-key value.

  Type Parameters

  • T = Record<string, unknown>

  Parameters

  • index: string
  • id: string | number

  Returns Promise<T>

deleteDocument

• deleteDocument(index: string, id: string | number): Promise<any>

  Delete a single document by its primary-key value. Returns the enqueued task.

  Parameters

  • index: string
  • id: string | number

  Returns Promise<any>

getStats

• getStats(): Promise<any>

  Get server-wide stats (database size, per-index document counts, etc.).

  Returns Promise<any>