Package version:

Class SearchIndexingBufferedSender<TModel>

Class used to perform buffered operations against a search index, including adding, updating, and removing them.

Type Parameters

  • TModel extends object

Constructors

constructor

Methods

deleteDocuments dispose flush mergeDocuments mergeOrUploadDocuments off on uploadDocuments

Constructors

constructor

Methods

deleteDocuments

  • deleteDocuments(documents, options?): Promise<void>

  • Deletes the documents/Adds the documents to the delete queue.

    Parameters

    • documents: TModel[]

      Documents to be deleted.

    • options: OperationOptions = {}

      Upload options.

    Returns Promise<void>

dispose

flush

  • flush(options?): Promise<void>

  • Flushes the queue manually.

    Parameters

    • options: OperationOptions = {}

      Flush options.

    Returns Promise<void>

mergeDocuments

  • mergeDocuments(documents, options?): Promise<void>

  • Merges the documents/Adds the documents to the merge queue.

    Parameters

    • documents: TModel[]

      Documents to be merged.

    • options: OperationOptions = {}

      Upload options.

    Returns Promise<void>

mergeOrUploadDocuments

  • mergeOrUploadDocuments(documents, options?): Promise<void>

  • Merges/Uploads the documents/Adds the documents to the merge/upload queue.

    Parameters

    • documents: TModel[]

      Documents to be merged/uploaded.

    • options: OperationOptions = {}

      Upload options.

    Returns Promise<void>

off

  • off(event, listener): void

  • Detach Batch Added Event

    Parameters

    • event: "batchAdded"

      Event to be emitted

    • listener: ((e: {
          action: string;
          documents: TModel[];
      }) => void)

      Event Listener

        • (e): void

        • Parameters

          • e: {
                action: string;
                documents: TModel[];
            }
            • action: string
            • documents: TModel[]

          Returns void

    Returns void

  • off(event, listener): void

  • Detach Batch Sent Event

    Parameters

    • event: "beforeDocumentSent"

      Event to be emitted

    • listener: ((e: any) => void)

      Event Listener

        • (e): void

        • Parameters

          • e: any

          Returns void

    Returns void

  • off(event, listener): void

  • Detach Batch Succeeded Event

    Parameters

    Returns void

  • off(event, listener): void

  • Detach Batch Failed Event

    Parameters

    • event: "batchFailed"

      Event to be emitted

    • listener: ((e: RestError) => void)

      Event Listener

        • (e): void

        • Parameters

          • e: RestError

          Returns void

    Returns void

on

  • on(event, listener): void

  • Attach Batch Added Event

    Parameters

    • event: "batchAdded"

      Event to be emitted

    • listener: ((e: {
          action: string;
          documents: TModel[];
      }) => void)

      Event Listener

        • (e): void

        • Parameters

          • e: {
                action: string;
                documents: TModel[];
            }
            • action: string
            • documents: TModel[]

          Returns void

    Returns void

  • on(event, listener): void

  • Attach Batch Sent Event

    Parameters

    • event: "beforeDocumentSent"

      Event to be emitted

    • listener: ((e: any) => void)

      Event Listener

        • (e): void

        • Parameters

          • e: any

          Returns void

    Returns void

  • on(event, listener): void

  • Attach Batch Succeeded Event

    Parameters

    Returns void

  • on(event, listener): void

  • Attach Batch Failed Event

    Parameters

    • event: "batchFailed"

      Event to be emitted

    • listener: ((e: RestError) => void)

      Event Listener

        • (e): void

        • Parameters

          • e: RestError

          Returns void

    Returns void

uploadDocuments

  • uploadDocuments(documents, options?): Promise<void>

  • Uploads the documents/Adds the documents to the upload queue.

    Parameters

    • documents: TModel[]

      Documents to be uploaded.

    • options: OperationOptions = {}

      Upload options.

    Returns Promise<void>

Settings

Member Visibility