@algolia/client-common 5.0.0-alpha.53 → 5.0.0-alpha.55

package/dist/client-common.cjs.js

@@ -67,15 +67,15 @@ function createEchoRequester({
   };
 }
 
-/**
- * Helper: Returns the promise of a given `func` to iterate on, based on a given `validate` condition.
- *
- * @param createIterator - The createIterator options.
- * @param createIterator.func - The function to run, which returns a promise.
- * @param createIterator.validate - The validator function. It receives the resolved return of `func`.
- * @param createIterator.aggregator - The function that runs right after the `func` method has been executed, allows you to do anything with the response before `validate`.
- * @param createIterator.error - The `validate` condition to throw an error, and its message.
- * @param createIterator.timeout - The function to decide how long to wait between iterations.
+/**
+ * Helper: Returns the promise of a given `func` to iterate on, based on a given `validate` condition.
+ *
+ * @param createIterator - The createIterator options.
+ * @param createIterator.func - The function to run, which returns a promise.
+ * @param createIterator.validate - The validator function. It receives the resolved return of `func`.
+ * @param createIterator.aggregator - The function that runs right after the `func` method has been executed, allows you to do anything with the response before `validate`.
+ * @param createIterator.error - The `validate` condition to throw an error, and its message.
+ * @param createIterator.timeout - The function to decide how long to wait between iterations.
  */
 function createIterablePromise({
   func,
@@ -473,16 +473,16 @@ function createTransporter({
     return {
       hosts: compatibleHostsAvailable,
       getTimeout(timeoutsCount, baseTimeout) {
-        /**
-         * Imagine that you have 4 hosts, if timeouts will increase
-         * on the following way: 1 (timed out) > 4 (timed out) > 5 (200).
-         *
-         * Note that, the very next request, we start from the previous timeout.
-         *
-         *  5 (timed out) > 6 (timed out) > 7 ...
-         *
-         * This strategy may need to be reviewed, but is the strategy on the our
-         * current v3 version.
+        /**
+         * Imagine that you have 4 hosts, if timeouts will increase
+         * on the following way: 1 (timed out) > 4 (timed out) > 5 (200).
+         *
+         * Note that, the very next request, we start from the previous timeout.
+         *
+         *  5 (timed out) > 6 (timed out) > 7 ...
+         *
+         * This strategy may need to be reviewed, but is the strategy on the our
+         * current v3 version.
          */
         const timeoutMultiplier = hostsTimedOut.length === 0 && timeoutsCount === 0 ? 1 : hostsTimedOut.length + 3 + timeoutsCount;
         return timeoutMultiplier * baseTimeout;
@@ -491,8 +491,8 @@ function createTransporter({
   }
   async function retryableRequest(request, requestOptions, isRead = true) {
     const stackTrace = [];
-    /**
-     * First we prepare the payload that do not depend from hosts.
+    /**
+     * First we prepare the payload that do not depend from hosts.
      */
     const data = serializeData(request, requestOptions);
     const headers = serializeHeaders(baseHeaders, request.headers, requestOptions.headers);
@@ -523,8 +523,8 @@ function createTransporter({
     }
     let timeoutsCount = 0;
     const retry = async (retryableHosts, getTimeout) => {
-      /**
-       * We iterate on each host, until there is no host left.
+      /**
+       * We iterate on each host, until there is no host left.
        */
       const host = retryableHosts.pop();
       if (host === undefined) {
@@ -542,10 +542,10 @@ function createTransporter({
         connectTimeout: getTimeout(timeoutsCount, timeouts.connect),
         responseTimeout: getTimeout(timeoutsCount, responseTimeout)
       };
-      /**
-       * The stackFrame is pushed to the stackTrace so we
-       * can have information about onRetry and onFailure
-       * decisions.
+      /**
+       * The stackFrame is pushed to the stackTrace so we
+       * can have information about onRetry and onFailure
+       * decisions.
        */
       const pushToStackTrace = response => {
         const stackFrame = {
@@ -564,17 +564,17 @@ function createTransporter({
         if (response.isTimedOut) {
           timeoutsCount++;
         }
-        /**
-         * Failures are individually sent to the logger, allowing
-         * the end user to debug / store stack frames even
-         * when a retry error does not happen.
+        /**
+         * Failures are individually sent to the logger, allowing
+         * the end user to debug / store stack frames even
+         * when a retry error does not happen.
          */
         // eslint-disable-next-line no-console -- this will be fixed by exposing a `logger` to the transporter
         console.log('Retryable failure', stackFrameWithoutCredentials(stackFrame));
-        /**
-         * We also store the state of the host in failure cases. If the host, is
-         * down it will remain down for the next 2 minutes. In a timeout situation,
-         * this host will be added end of the list of hosts on the next request.
+        /**
+         * We also store the state of the host in failure cases. If the host, is
+         * down it will remain down for the next 2 minutes. In a timeout situation,
+         * this host will be added end of the list of hosts on the next request.
          */
         await hostsCache.set(host, createStatefulHost(host, response.isTimedOut ? 'timed out' : 'down'));
         return retry(retryableHosts, getTimeout);
@@ -585,56 +585,56 @@ function createTransporter({
       pushToStackTrace(response);
       throw deserializeFailure(response, stackTrace);
     };
-    /**
-     * Finally, for each retryable host perform request until we got a non
-     * retryable response. Some notes here:
-     *
-     * 1. The reverse here is applied so we can apply a `pop` later on => more performant.
-     * 2. We also get from the retryable options a timeout multiplier that is tailored
-     * for the current context.
+    /**
+     * Finally, for each retryable host perform request until we got a non
+     * retryable response. Some notes here:
+     *
+     * 1. The reverse here is applied so we can apply a `pop` later on => more performant.
+     * 2. We also get from the retryable options a timeout multiplier that is tailored
+     * for the current context.
      */
     const compatibleHosts = hosts.filter(host => host.accept === 'readWrite' || (isRead ? host.accept === 'read' : host.accept === 'write'));
     const options = await createRetryableOptions(compatibleHosts);
     return retry([...options.hosts].reverse(), options.getTimeout);
   }
   function createRequest(request, requestOptions = {}) {
-    /**
-     * A read request is either a `GET` request, or a request that we make
-     * via the `read` transporter (e.g. `search`).
+    /**
+     * A read request is either a `GET` request, or a request that we make
+     * via the `read` transporter (e.g. `search`).
      */
     const isRead = request.useReadTransporter || request.method === 'GET';
     if (!isRead) {
-      /**
-       * On write requests, no cache mechanisms are applied, and we
-       * proxy the request immediately to the requester.
+      /**
+       * On write requests, no cache mechanisms are applied, and we
+       * proxy the request immediately to the requester.
        */
       return retryableRequest(request, requestOptions, isRead);
     }
     const createRetryableRequest = () => {
-      /**
-       * Then, we prepare a function factory that contains the construction of
-       * the retryable request. At this point, we may *not* perform the actual
-       * request. But we want to have the function factory ready.
+      /**
+       * Then, we prepare a function factory that contains the construction of
+       * the retryable request. At this point, we may *not* perform the actual
+       * request. But we want to have the function factory ready.
        */
       return retryableRequest(request, requestOptions);
     };
-    /**
-     * Once we have the function factory ready, we need to determine of the
-     * request is "cacheable" - should be cached. Note that, once again,
-     * the user can force this option.
+    /**
+     * Once we have the function factory ready, we need to determine of the
+     * request is "cacheable" - should be cached. Note that, once again,
+     * the user can force this option.
      */
     const cacheable = requestOptions.cacheable || request.cacheable;
-    /**
-     * If is not "cacheable", we immediately trigger the retryable request, no
-     * need to check cache implementations.
+    /**
+     * If is not "cacheable", we immediately trigger the retryable request, no
+     * need to check cache implementations.
      */
     if (cacheable !== true) {
       return createRetryableRequest();
     }
-    /**
-     * If the request is "cacheable", we need to first compute the key to ask
-     * the cache implementations if this request is on progress or if the
-     * response already exists on the cache.
+    /**
+     * If the request is "cacheable", we need to first compute the key to ask
+     * the cache implementations if this request is on progress or if the
+     * response already exists on the cache.
      */
     const key = {
       request,
@@ -644,27 +644,27 @@ function createTransporter({
         headers: baseHeaders
       }
     };
-    /**
-     * With the computed key, we first ask the responses cache
-     * implementation if this request was been resolved before.
+    /**
+     * With the computed key, we first ask the responses cache
+     * implementation if this request was been resolved before.
      */
     return responsesCache.get(key, () => {
-      /**
-       * If the request has never resolved before, we actually ask if there
-       * is a current request with the same key on progress.
+      /**
+       * If the request has never resolved before, we actually ask if there
+       * is a current request with the same key on progress.
        */
       return requestsCache.get(key, () =>
-      /**
-       * Finally, if there is no request in progress with the same key,
-       * this `createRetryableRequest()` will actually trigger the
-       * retryable request.
+      /**
+       * Finally, if there is no request in progress with the same key,
+       * this `createRetryableRequest()` will actually trigger the
+       * retryable request.
        */
       requestsCache.set(key, createRetryableRequest()).then(response => Promise.all([requestsCache.delete(key), response]), err => Promise.all([requestsCache.delete(key), Promise.reject(err)])).then(([_, response]) => response));
     }, {
-      /**
-       * Of course, once we get this response back from the server, we
-       * tell response cache to actually store the received response
-       * to be used later.
+      /**
+       * Of course, once we get this response back from the server, we
+       * tell response cache to actually store the received response
+       * to be used later.
        */
       miss: response => responsesCache.set(key, response)
     });

package/dist/client-common.esm.node.js

@@ -63,15 +63,15 @@ function createEchoRequester({
   };
 }
 
-/**
- * Helper: Returns the promise of a given `func` to iterate on, based on a given `validate` condition.
- *
- * @param createIterator - The createIterator options.
- * @param createIterator.func - The function to run, which returns a promise.
- * @param createIterator.validate - The validator function. It receives the resolved return of `func`.
- * @param createIterator.aggregator - The function that runs right after the `func` method has been executed, allows you to do anything with the response before `validate`.
- * @param createIterator.error - The `validate` condition to throw an error, and its message.
- * @param createIterator.timeout - The function to decide how long to wait between iterations.
+/**
+ * Helper: Returns the promise of a given `func` to iterate on, based on a given `validate` condition.
+ *
+ * @param createIterator - The createIterator options.
+ * @param createIterator.func - The function to run, which returns a promise.
+ * @param createIterator.validate - The validator function. It receives the resolved return of `func`.
+ * @param createIterator.aggregator - The function that runs right after the `func` method has been executed, allows you to do anything with the response before `validate`.
+ * @param createIterator.error - The `validate` condition to throw an error, and its message.
+ * @param createIterator.timeout - The function to decide how long to wait between iterations.
  */
 function createIterablePromise({
   func,
@@ -469,16 +469,16 @@ function createTransporter({
     return {
       hosts: compatibleHostsAvailable,
       getTimeout(timeoutsCount, baseTimeout) {
-        /**
-         * Imagine that you have 4 hosts, if timeouts will increase
-         * on the following way: 1 (timed out) > 4 (timed out) > 5 (200).
-         *
-         * Note that, the very next request, we start from the previous timeout.
-         *
-         *  5 (timed out) > 6 (timed out) > 7 ...
-         *
-         * This strategy may need to be reviewed, but is the strategy on the our
-         * current v3 version.
+        /**
+         * Imagine that you have 4 hosts, if timeouts will increase
+         * on the following way: 1 (timed out) > 4 (timed out) > 5 (200).
+         *
+         * Note that, the very next request, we start from the previous timeout.
+         *
+         *  5 (timed out) > 6 (timed out) > 7 ...
+         *
+         * This strategy may need to be reviewed, but is the strategy on the our
+         * current v3 version.
          */
         const timeoutMultiplier = hostsTimedOut.length === 0 && timeoutsCount === 0 ? 1 : hostsTimedOut.length + 3 + timeoutsCount;
         return timeoutMultiplier * baseTimeout;
@@ -487,8 +487,8 @@ function createTransporter({
   }
   async function retryableRequest(request, requestOptions, isRead = true) {
     const stackTrace = [];
-    /**
-     * First we prepare the payload that do not depend from hosts.
+    /**
+     * First we prepare the payload that do not depend from hosts.
      */
     const data = serializeData(request, requestOptions);
     const headers = serializeHeaders(baseHeaders, request.headers, requestOptions.headers);
@@ -519,8 +519,8 @@ function createTransporter({
     }
     let timeoutsCount = 0;
     const retry = async (retryableHosts, getTimeout) => {
-      /**
-       * We iterate on each host, until there is no host left.
+      /**
+       * We iterate on each host, until there is no host left.
        */
       const host = retryableHosts.pop();
       if (host === undefined) {
@@ -538,10 +538,10 @@ function createTransporter({
         connectTimeout: getTimeout(timeoutsCount, timeouts.connect),
         responseTimeout: getTimeout(timeoutsCount, responseTimeout)
       };
-      /**
-       * The stackFrame is pushed to the stackTrace so we
-       * can have information about onRetry and onFailure
-       * decisions.
+      /**
+       * The stackFrame is pushed to the stackTrace so we
+       * can have information about onRetry and onFailure
+       * decisions.
        */
       const pushToStackTrace = response => {
         const stackFrame = {
@@ -560,17 +560,17 @@ function createTransporter({
         if (response.isTimedOut) {
           timeoutsCount++;
         }
-        /**
-         * Failures are individually sent to the logger, allowing
-         * the end user to debug / store stack frames even
-         * when a retry error does not happen.
+        /**
+         * Failures are individually sent to the logger, allowing
+         * the end user to debug / store stack frames even
+         * when a retry error does not happen.
          */
         // eslint-disable-next-line no-console -- this will be fixed by exposing a `logger` to the transporter
         console.log('Retryable failure', stackFrameWithoutCredentials(stackFrame));
-        /**
-         * We also store the state of the host in failure cases. If the host, is
-         * down it will remain down for the next 2 minutes. In a timeout situation,
-         * this host will be added end of the list of hosts on the next request.
+        /**
+         * We also store the state of the host in failure cases. If the host, is
+         * down it will remain down for the next 2 minutes. In a timeout situation,
+         * this host will be added end of the list of hosts on the next request.
          */
         await hostsCache.set(host, createStatefulHost(host, response.isTimedOut ? 'timed out' : 'down'));
         return retry(retryableHosts, getTimeout);
@@ -581,56 +581,56 @@ function createTransporter({
       pushToStackTrace(response);
       throw deserializeFailure(response, stackTrace);
     };
-    /**
-     * Finally, for each retryable host perform request until we got a non
-     * retryable response. Some notes here:
-     *
-     * 1. The reverse here is applied so we can apply a `pop` later on => more performant.
-     * 2. We also get from the retryable options a timeout multiplier that is tailored
-     * for the current context.
+    /**
+     * Finally, for each retryable host perform request until we got a non
+     * retryable response. Some notes here:
+     *
+     * 1. The reverse here is applied so we can apply a `pop` later on => more performant.
+     * 2. We also get from the retryable options a timeout multiplier that is tailored
+     * for the current context.
      */
     const compatibleHosts = hosts.filter(host => host.accept === 'readWrite' || (isRead ? host.accept === 'read' : host.accept === 'write'));
     const options = await createRetryableOptions(compatibleHosts);
     return retry([...options.hosts].reverse(), options.getTimeout);
   }
   function createRequest(request, requestOptions = {}) {
-    /**
-     * A read request is either a `GET` request, or a request that we make
-     * via the `read` transporter (e.g. `search`).
+    /**
+     * A read request is either a `GET` request, or a request that we make
+     * via the `read` transporter (e.g. `search`).
      */
     const isRead = request.useReadTransporter || request.method === 'GET';
     if (!isRead) {
-      /**
-       * On write requests, no cache mechanisms are applied, and we
-       * proxy the request immediately to the requester.
+      /**
+       * On write requests, no cache mechanisms are applied, and we
+       * proxy the request immediately to the requester.
        */
       return retryableRequest(request, requestOptions, isRead);
     }
     const createRetryableRequest = () => {
-      /**
-       * Then, we prepare a function factory that contains the construction of
-       * the retryable request. At this point, we may *not* perform the actual
-       * request. But we want to have the function factory ready.
+      /**
+       * Then, we prepare a function factory that contains the construction of
+       * the retryable request. At this point, we may *not* perform the actual
+       * request. But we want to have the function factory ready.
        */
       return retryableRequest(request, requestOptions);
     };
-    /**
-     * Once we have the function factory ready, we need to determine of the
-     * request is "cacheable" - should be cached. Note that, once again,
-     * the user can force this option.
+    /**
+     * Once we have the function factory ready, we need to determine of the
+     * request is "cacheable" - should be cached. Note that, once again,
+     * the user can force this option.
      */
     const cacheable = requestOptions.cacheable || request.cacheable;
-    /**
-     * If is not "cacheable", we immediately trigger the retryable request, no
-     * need to check cache implementations.
+    /**
+     * If is not "cacheable", we immediately trigger the retryable request, no
+     * need to check cache implementations.
      */
     if (cacheable !== true) {
       return createRetryableRequest();
     }
-    /**
-     * If the request is "cacheable", we need to first compute the key to ask
-     * the cache implementations if this request is on progress or if the
-     * response already exists on the cache.
+    /**
+     * If the request is "cacheable", we need to first compute the key to ask
+     * the cache implementations if this request is on progress or if the
+     * response already exists on the cache.
      */
     const key = {
       request,
@@ -640,27 +640,27 @@ function createTransporter({
         headers: baseHeaders
       }
     };
-    /**
-     * With the computed key, we first ask the responses cache
-     * implementation if this request was been resolved before.
+    /**
+     * With the computed key, we first ask the responses cache
+     * implementation if this request was been resolved before.
      */
     return responsesCache.get(key, () => {
-      /**
-       * If the request has never resolved before, we actually ask if there
-       * is a current request with the same key on progress.
+      /**
+       * If the request has never resolved before, we actually ask if there
+       * is a current request with the same key on progress.
        */
       return requestsCache.get(key, () =>
-      /**
-       * Finally, if there is no request in progress with the same key,
-       * this `createRetryableRequest()` will actually trigger the
-       * retryable request.
+      /**
+       * Finally, if there is no request in progress with the same key,
+       * this `createRetryableRequest()` will actually trigger the
+       * retryable request.
        */
       requestsCache.set(key, createRetryableRequest()).then(response => Promise.all([requestsCache.delete(key), response]), err => Promise.all([requestsCache.delete(key), Promise.reject(err)])).then(([_, response]) => response));
     }, {
-      /**
-       * Of course, once we get this response back from the server, we
-       * tell response cache to actually store the received response
-       * to be used later.
+      /**
+       * Of course, once we get this response back from the server, we
+       * tell response cache to actually store the received response
+       * to be used later.
        */
       miss: response => responsesCache.set(key, response)
     });

package/dist/index.d.ts

@@ -1,10 +1,10 @@
-export * from './src/createAuth';
-export * from './src/createEchoRequester';
-export * from './src/createIterablePromise';
-export * from './src/cache';
-export * from './src/transporter';
-export * from './src/createAlgoliaAgent';
-export * from './src/getAlgoliaAgent';
-export * from './src/types';
-export * from './src/constants';
+export * from './src/createAuth';
+export * from './src/createEchoRequester';
+export * from './src/createIterablePromise';
+export * from './src/cache';
+export * from './src/transporter';
+export * from './src/createAlgoliaAgent';
+export * from './src/getAlgoliaAgent';
+export * from './src/types';
+export * from './src/constants';
 //# sourceMappingURL=index.d.ts.map

package/dist/src/cache/createBrowserLocalStorageCache.d.ts

@@ -1,3 +1,3 @@
-import type { BrowserLocalStorageOptions, Cache } from '../types';
-export declare function createBrowserLocalStorageCache(options: BrowserLocalStorageOptions): Cache;
+import type { BrowserLocalStorageOptions, Cache } from '../types';
+export declare function createBrowserLocalStorageCache(options: BrowserLocalStorageOptions): Cache;
 //# sourceMappingURL=createBrowserLocalStorageCache.d.ts.map

package/dist/src/cache/createFallbackableCache.d.ts

@@ -1,3 +1,3 @@
-import type { FallbackableCacheOptions, Cache } from '../types';
-export declare function createFallbackableCache(options: FallbackableCacheOptions): Cache;
+import type { FallbackableCacheOptions, Cache } from '../types';
+export declare function createFallbackableCache(options: FallbackableCacheOptions): Cache;
 //# sourceMappingURL=createFallbackableCache.d.ts.map

package/dist/src/cache/createMemoryCache.d.ts

@@ -1,3 +1,3 @@
-import type { Cache, MemoryCacheOptions } from '../types';
-export declare function createMemoryCache(options?: MemoryCacheOptions): Cache;
+import type { Cache, MemoryCacheOptions } from '../types';
+export declare function createMemoryCache(options?: MemoryCacheOptions): Cache;
 //# sourceMappingURL=createMemoryCache.d.ts.map

package/dist/src/cache/createNullCache.d.ts

@@ -1,3 +1,3 @@
-import type { Cache } from '../types';
-export declare function createNullCache(): Cache;
+import type { Cache } from '../types';
+export declare function createNullCache(): Cache;
 //# sourceMappingURL=createNullCache.d.ts.map

package/dist/src/cache/index.d.ts

@@ -1,5 +1,5 @@
-export * from './createBrowserLocalStorageCache';
-export * from './createFallbackableCache';
-export * from './createMemoryCache';
-export * from './createNullCache';
+export * from './createBrowserLocalStorageCache';
+export * from './createFallbackableCache';
+export * from './createMemoryCache';
+export * from './createNullCache';
 //# sourceMappingURL=index.d.ts.map

package/dist/src/constants.d.ts

@@ -1,7 +1,7 @@
-export declare const DEFAULT_CONNECT_TIMEOUT_BROWSER = 1000;
-export declare const DEFAULT_READ_TIMEOUT_BROWSER = 2000;
-export declare const DEFAULT_WRITE_TIMEOUT_BROWSER = 30000;
-export declare const DEFAULT_CONNECT_TIMEOUT_NODE = 2000;
-export declare const DEFAULT_READ_TIMEOUT_NODE = 5000;
-export declare const DEFAULT_WRITE_TIMEOUT_NODE = 30000;
+export declare const DEFAULT_CONNECT_TIMEOUT_BROWSER = 1000;
+export declare const DEFAULT_READ_TIMEOUT_BROWSER = 2000;
+export declare const DEFAULT_WRITE_TIMEOUT_BROWSER = 30000;
+export declare const DEFAULT_CONNECT_TIMEOUT_NODE = 2000;
+export declare const DEFAULT_READ_TIMEOUT_NODE = 5000;
+export declare const DEFAULT_WRITE_TIMEOUT_NODE = 30000;
 //# sourceMappingURL=constants.d.ts.map

package/dist/src/createAlgoliaAgent.d.ts

@@ -1,3 +1,3 @@
-import type { AlgoliaAgent } from './types';
-export declare function createAlgoliaAgent(version: string): AlgoliaAgent;
+import type { AlgoliaAgent } from './types';
+export declare function createAlgoliaAgent(version: string): AlgoliaAgent;
 //# sourceMappingURL=createAlgoliaAgent.d.ts.map

package/dist/src/createAuth.d.ts

@@ -1,6 +1,6 @@
-import type { AuthMode, Headers, QueryParameters } from './types';
-export declare function createAuth(appId: string, apiKey: string, authMode?: AuthMode): {
-    readonly headers: () => Headers;
-    readonly queryParameters: () => QueryParameters;
-};
+import type { AuthMode, Headers, QueryParameters } from './types';
+export declare function createAuth(appId: string, apiKey: string, authMode?: AuthMode): {
+    readonly headers: () => Headers;
+    readonly queryParameters: () => QueryParameters;
+};
 //# sourceMappingURL=createAuth.d.ts.map

package/dist/src/createEchoRequester.d.ts

@@ -1,7 +1,7 @@
-import type { Requester } from './types';
-export type EchoRequesterParams = {
-    getURL: (url: string) => URL;
-    status?: number;
-};
-export declare function createEchoRequester({ getURL, status, }: EchoRequesterParams): Requester;
+import type { Requester } from './types';
+export type EchoRequesterParams = {
+    getURL: (url: string) => URL;
+    status?: number;
+};
+export declare function createEchoRequester({ getURL, status, }: EchoRequesterParams): Requester;
 //# sourceMappingURL=createEchoRequester.d.ts.map

package/dist/src/createIterablePromise.d.ts

@@ -1,13 +1,13 @@
-import type { CreateIterablePromise } from './types/createIterablePromise';
-/**
- * Helper: Returns the promise of a given `func` to iterate on, based on a given `validate` condition.
- *
- * @param createIterator - The createIterator options.
- * @param createIterator.func - The function to run, which returns a promise.
- * @param createIterator.validate - The validator function. It receives the resolved return of `func`.
- * @param createIterator.aggregator - The function that runs right after the `func` method has been executed, allows you to do anything with the response before `validate`.
- * @param createIterator.error - The `validate` condition to throw an error, and its message.
- * @param createIterator.timeout - The function to decide how long to wait between iterations.
- */
-export declare function createIterablePromise<TResponse>({ func, validate, aggregator, error, timeout, }: CreateIterablePromise<TResponse>): Promise<TResponse>;
+import type { CreateIterablePromise } from './types/createIterablePromise';
+/**
+ * Helper: Returns the promise of a given `func` to iterate on, based on a given `validate` condition.
+ *
+ * @param createIterator - The createIterator options.
+ * @param createIterator.func - The function to run, which returns a promise.
+ * @param createIterator.validate - The validator function. It receives the resolved return of `func`.
+ * @param createIterator.aggregator - The function that runs right after the `func` method has been executed, allows you to do anything with the response before `validate`.
+ * @param createIterator.error - The `validate` condition to throw an error, and its message.
+ * @param createIterator.timeout - The function to decide how long to wait between iterations.
+ */
+export declare function createIterablePromise<TResponse>({ func, validate, aggregator, error, timeout, }: CreateIterablePromise<TResponse>): Promise<TResponse>;
 //# sourceMappingURL=createIterablePromise.d.ts.map

package/dist/src/getAlgoliaAgent.d.ts

@@ -1,8 +1,8 @@
-import type { AlgoliaAgentOptions, AlgoliaAgent } from './types';
-export type GetAlgoliaAgent = {
-    algoliaAgents: AlgoliaAgentOptions[];
-    client: string;
-    version: string;
-};
-export declare function getAlgoliaAgent({ algoliaAgents, client, version, }: GetAlgoliaAgent): AlgoliaAgent;
+import type { AlgoliaAgentOptions, AlgoliaAgent } from './types';
+export type GetAlgoliaAgent = {
+    algoliaAgents: AlgoliaAgentOptions[];
+    client: string;
+    version: string;
+};
+export declare function getAlgoliaAgent({ algoliaAgents, client, version, }: GetAlgoliaAgent): AlgoliaAgent;
 //# sourceMappingURL=getAlgoliaAgent.d.ts.map

package/dist/src/transporter/createStatefulHost.d.ts

@@ -1,3 +1,3 @@
-import type { Host, StatefulHost } from '../types';
-export declare function createStatefulHost(host: Host, status?: StatefulHost['status']): StatefulHost;
+import type { Host, StatefulHost } from '../types';
+export declare function createStatefulHost(host: Host, status?: StatefulHost['status']): StatefulHost;
 //# sourceMappingURL=createStatefulHost.d.ts.map