Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IndexDocumentsBatch<T>

Package version

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

Type parameters

  • T

Hierarchy

  • IndexDocumentsBatch

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

actions

actions: IndexDocumentsAction<T>[]

The set of actions taken in this batch.

Methods

delete

  • delete(keyName: keyof T, keyValues: string[]): void
  • delete(documents: T[]): void
  • Delete a set of documents.

    Parameters

    • keyName: keyof T

      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: T[]

      Documents to be deleted.

    Returns void

merge

  • merge(documents: T[]): void

mergeOrUpload

  • mergeOrUpload(documents: T[]): void

upload

  • upload(documents: T[]): void
  • Upload an array of documents to the index.

    Parameters

    • documents: T[]

      The documents to upload.

    Returns void

Generated using TypeDoc