Type alias VacuumOptions

VacuumOptions: {
    batchSize?: number;
    batchWait?: number;
}

Options to control vacuuming behavior.

Vacuuming cleans up document references made obsolete by MiniSearch.discard from the index. On large indexes, vacuuming is potentially costly, because it has to traverse the whole inverted index. Therefore, in order to dilute this cost so it does not negatively affects the application, vacuuming is performed in batches, with a delay between each batch. These options are used to configure the batch size and the delay between batches.

Type declaration

  • Optional batchSize?: number

    Size of each vacuuming batch (the number of terms in the index that will be traversed in each batch). Defaults to 1000.

  • Optional batchWait?: number

    Wait time between each vacuuming batch in milliseconds. Defaults to 10.

Generated using TypeDoc