Class TypesenseStore

constructor

• new TypesenseStore(options: TypesenseStoreOptions): TypesenseStore

  Parameters

  • options: TypesenseStoreOptions

  Returns TypesenseStore

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 typesense client for anything not wrapped here.

  Returns any

createCollection

• createCollection(schema: Record<string, unknown>): Promise<any>

  Create a collection from a schema ({ name, fields, default_sorting_field? }).

  Parameters

  • schema: Record<string, unknown>

  Returns Promise<any>

deleteCollection

• deleteCollection(name: string): Promise<any>

  Delete a collection by name.

  Parameters

  • name: string

  Returns Promise<any>

indexDocument

• indexDocument(
      collection: string,
      document: Record<string, unknown>,
  ): Promise<any>

  Index (create) a single document in a collection.

  Parameters

  • collection: string
  • document: Record<string, unknown>

  Returns Promise<any>

search

• search<T = Record<string, unknown>>(
      collection: string,
      params: Record<string, unknown>,
  ): Promise<T>

  Run a search against a collection's documents.

  Type Parameters

  • T = Record<string, unknown>

  Parameters

  • collection: string
  • params: Record<string, unknown>

  Returns Promise<T>

getDocument

• getDocument<T = Record<string, unknown>>(
      collection: string,
      id: string,
  ): Promise<T>

  Retrieve a single document by its id.

  Type Parameters

  • T = Record<string, unknown>

  Parameters

  • collection: string
  • id: string

  Returns Promise<T>

deleteDocument

• deleteDocument(collection: string, id: string): Promise<any>

  Delete a single document by its id.

  Parameters

  • collection: string
  • id: string

  Returns Promise<any>