@daiso-tech/core/dist/async/middlewares/retry/retry.middleware.d.ts

The library offers flexible, framework-agnostic solutions for modern web applications, built on adaptable components that integrate seamlessly with popular frameworks like Next Js.

/**
 * @module Async
 */
import { TimeSpan, type Invokable, type HookContext, type AsyncMiddlewareFn } from "../../../utilities/_module-exports.js";
import { type BackoffPolicy } from "../../../async/backof-policies/_module.js";
/**
 *
 * IMPORT_PATH: `"@daiso-tech/core/async"`
 * @group Utilities
 */
export type OnExecutionAttemptData<TParameters extends unknown[] = unknown[], TContext extends HookContext = HookContext> = {
    attempt: number;
    args: TParameters;
    context: TContext;
};
/**
 *
 * IMPORT_PATH: `"@daiso-tech/core/async"`
 * @group Utilities
 */
export type OnExecutionAttempt<TParameters extends unknown[] = unknown[], TContext extends HookContext = HookContext> = Invokable<[data: OnExecutionAttemptData<TParameters, TContext>]>;
/**
 *
 * IMPORT_PATH: `"@daiso-tech/core/async"`
 * @group Utilities
 */
export type OnRetryData<TParameters extends unknown[] = unknown[], TContext extends HookContext = HookContext> = {
    error: unknown;
    attempt: number;
    waitTime: TimeSpan;
    args: TParameters;
    context: TContext;
};
/**
 *
 * IMPORT_PATH: `"@daiso-tech/core/async"`
 * @group Utilities
 */
export type OnRetry<TParameters extends unknown[] = unknown[], TContext extends HookContext = HookContext> = Invokable<[data: OnRetryData<TParameters, TContext>]>;
/**
 *
 * IMPORT_PATH: `"@daiso-tech/core/async"`
 * @group Utilities
 */
export type RetryPolicy = Invokable<[error: unknown, attempt: number], boolean>;
/**
 *
 * IMPORT_PATH: `"@daiso-tech/core/async"`
 * @group Utilities
 */
export type RetrySettings<TParameters extends unknown[] = unknown[], TContext extends HookContext = HookContext> = {
    /**
     * You can decide maximal times you can retry.
     * @default {4}
     */
    maxAttempts?: number;
    /**
     * @default
     * ```ts
     * import { exponentialBackoffPolicy } from "@daiso-tech/core/async";
     *
     * exponentialBackoffPolicy();
     * ```
     */
    backoffPolicy?: BackoffPolicy;
    /**
     * You can choose what errors you want to retry. By default all erros will be retried.
     *
     * @default
     * ```ts
     * () => true
     * ```
     */
    retryPolicy?: RetryPolicy;
    /**
     * Callback function that will be called before execution attempt.
     */
    onExecutionAttempt?: OnExecutionAttempt<TParameters, TContext>;
    /**
     * Callback function that will be called when the retry delay starts.
     */
    onRetryStart?: OnRetry<TParameters, TContext>;
    /**
     * Callback function that will be called when the retry delay ends and before the next execution attempt.
     */
    onRetryEnd?: OnRetry<TParameters, TContext>;
};
/**
 * The `retry` middleware enables automatic retries for all errors or specific errors, with configurable backoff policies.
 * An error will be thrown when all retry attempts fail.
 *
 * IMPORT_PATH: `"@daiso-tech/core/async"`
 * @group Middleware
 *
 * @throws {AbortAsyncError} {@link AbortAsyncError}
 *
 * @example
 * ```ts
 * import { retry } from "@daiso-tech/core/async";
 * import { AsyncHooks } from "@daiso-tech/core/utilities";
 *
 * await new AsyncHooks(async (url: string) => {
 *   const response = await fetch(url);
 *   const json = await response.json();
 *   if (!response.ok) {
 *     throw json
 *   }
 *   return json;
 * }, retry({ maxAttempts: 8 })).invoke("URL_ENDPOINT");
 * ```
 */
export declare function retry<TParameters extends unknown[], TReturn, TContext extends HookContext>(settings?: NoInfer<RetrySettings<TParameters, TContext>>): AsyncMiddlewareFn<TParameters, TReturn, TContext>;