@algolia/client-search 5.25.0 → 5.27.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -11,7 +11,7 @@ import {
11
11
  getAlgoliaAgent,
12
12
  shuffle
13
13
  } from "@algolia/client-common";
14
- var apiClientVersion = "5.25.0";
14
+ var apiClientVersion = "5.27.0";
15
15
  function getDefaultHosts(appId) {
16
16
  return [
17
17
  {
@@ -372,7 +372,7 @@ function createSearchClient({
372
372
  * @param saveObjects - The `saveObjects` object.
373
373
  * @param saveObjects.indexName - The `indexName` to save `objects` in.
374
374
  * @param saveObjects.objects - The array of `objects` to store in the given Algolia `indexName`.
375
- * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
375
+ * @param saveObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
376
376
  * @param saveObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
377
377
  * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
378
378
  */
@@ -389,7 +389,7 @@ function createSearchClient({
389
389
  * @param deleteObjects - The `deleteObjects` object.
390
390
  * @param deleteObjects.indexName - The `indexName` to delete `objectIDs` from.
391
391
  * @param deleteObjects.objectIDs - The objectIDs to delete.
392
- * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
392
+ * @param deleteObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
393
393
  * @param deleteObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
394
394
  * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `batch` method and merged with the transporter requestOptions.
395
395
  */
@@ -413,7 +413,7 @@ function createSearchClient({
413
413
  * @param partialUpdateObjects.indexName - The `indexName` to update `objects` in.
414
414
  * @param partialUpdateObjects.objects - The array of `objects` to update in the given Algolia `indexName`.
415
415
  * @param partialUpdateObjects.createIfNotExists - To be provided if non-existing objects are passed, otherwise, the call will fail..
416
- * @param chunkedBatch.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
416
+ * @param partialUpdateObjects.batchSize - The size of the chunk of `objects`. The number of `batch` calls will be equal to `length(objects) / batchSize`. Defaults to 1000.
417
417
  * @param partialUpdateObjects.waitForTasks - Whether or not we should wait until every `batch` tasks has been processed, this operation may slow the total execution time of this method but is more reliable.
418
418
  * @param requestOptions - The requestOptions to send along with the query, they will be forwarded to the `getTask` method and merged with the transporter requestOptions.
419
419
  */
@@ -1366,7 +1366,7 @@ function createSearchClient({
1366
1366
  * Retrieves an object with non-null index settings.
1367
1367
  *
1368
1368
  * Required API Key ACLs:
1369
- * - search
1369
+ * - settings
1370
1370
  * @param getSettings - The getSettings object.
1371
1371
  * @param getSettings.indexName - Name of the index on which to perform the operation.
1372
1372
  * @param requestOptions - The requestOptions to send along with the query, they will be merged with the transporter requestOptions.