Package version:

Class IndexDocumentsBatch<TModel>

Class used to perform batch operations with multiple documents to the index.

Type Parameters

  • TModel

Constructors

Properties

Methods

Constructors

Properties

actions: any[]

The set of actions taken in this batch.

Methods

  • Delete a set of documents.

    Parameters

    • keyName: keyof TModel

      The name of their primary key in the index.

    • keyValues: string[]

      The primary key values of documents to delete.

    Returns void

  • Delete a set of documents.

    Parameters

    • documents: TModel[]

      Documents to be deleted.

    Returns void

  • Upload an array of documents to the index.

    Parameters

    • documents: TModel[]

      The documents to upload.

    Returns void