retry

Promise를 반환하는 함수가 성공할 때까지 다시 시도하는 함수입니다.

재시도 횟수(count)와 재시도 사이 간격(delay)을 설정할 수 있습니다. delay는 숫자로 고정 간격을 지정하거나, (attempt, error) => number 함수로 매 시도마다 다른 간격(예: 지수 백오프)을 계산할 수 있습니다. shouldRetry로 재시도 여부를 제어하고 signal로 재시도 작업을 중단할 수 있습니다.

Code

🔗 실제 구현 코드 확인

Interface

retry는 인자에 따라 아래 3가지 시그니처로 오버로딩되어 있습니다.

typescript

type RetryDelay = number | ((attempt: number, error: unknown) => number);

interface RetryOptions {
  count?: number;
  delay?: RetryDelay;
  signal?: AbortSignal;
  shouldRetry?: ((error: unknown, attempt: number) => boolean) | boolean;
}

// 1. 옵션 없이 호출 (지연 없이 재시도하지 않음)
function retry<T>(func: () => Promise<T>): Promise<T>;

// 2. 재시도 횟수만 전달 (지연 없이 재시도)
function retry<T>(func: () => Promise<T>, count: number): Promise<T>;

// 3. 옵션 객체 전달
function retry<T>(
  func: () => Promise<T>,
  options: RetryOptions
): Promise<T>;

Parameters

Name	Type	Default	Description
func	() => Promise<T>	-	재시도할 Promise를 반환하는 함수입니다.
options	number | RetryOptions	-	재시도 횟수(number) 또는 옵션 객체입니다.

Options

Name	Type	Default	Description
count	number	0	재시도 횟수입니다.
delay	number | ((attempt: number, error: unknown) => number)	0	재시도 사이의 대기 시간(ms)입니다. 숫자를 전달하면 고정 간격으로 대기하며, 함수를 전달하면 시도 인덱스(attempt, 0부터 시작)와 발생한 에러를 인자로 받아 대기 시간(ms)을 반환합니다. 지수 백오프처럼 매 시도마다 다른 간격이 필요할 때 함수를 사용합니다.
shouldRetry	((error: unknown, attempt: number) => boolean) | boolean	true	재시도 여부를 결정합니다. 함수를 전달하면 발생한 에러와 현재 시도 인덱스(attempt, 0부터 시작)를 인자로 받아 boolean을 반환하며, false(또는 false 반환) 시 재시도하지 않고 즉시 에러를 던집니다.
signal	AbortSignal	-	재시도 작업을 중단할 수 있는 AbortSignal입니다.

Usage

기본 사용법

typescript

import { retry } from '@modern-kit/utils';

// fetchData 함수가 성공할 때까지 지연 없이 최대 5번 재시도합니다.
const data = await retry(fetchData, 5);

고정 간격(delay) 사용

typescript

import { retry } from '@modern-kit/utils';

// fetchData 함수가 실패할 경우 1초(1000ms) 간격으로 최대 5번 재시도합니다.
const data = await retry(fetchData, { count: 5, delay: 1000 });

지수 백오프 사용

delay에 함수를 전달하면 시도 인덱스(attempt, 0부터 시작)를 이용해 매 시도마다 다른 대기 시간을 계산할 수 있습니다.

typescript

import { retry } from '@modern-kit/utils';

// 300ms, 600ms, 1200ms... 지수 백오프 간격으로 최대 5번 재시도합니다.
const data = await retry(fetchData, {
  count: 5,
  delay: (attempt) => 300 * 2 ** attempt,
});

재시도 여부 제어(shouldRetry)

shouldRetry 함수는 발생한 에러와 현재 시도 인덱스(attempt, 0부터 시작)를 인자로 받습니다.

typescript

import { retry } from '@modern-kit/utils';

// isRetryable가 false를 반환하는 에러는 재시도하지 않고 즉시 던집니다.
const data = await retry(fetchData, {
  count: 5,
  delay: 1000,
  shouldRetry: (error) => isRetryable(error),
});

// attempt(0부터 시작)를 활용해 특정 시도 이후에는 재시도를 멈출 수 있습니다.
const data2 = await retry(fetchData, {
  count: 5,
  delay: 1000,
  shouldRetry: (error, attempt) => isRetryable(error) && attempt < 2,
});

AbortSignal 사용

typescript

import { retry } from '@modern-kit/utils';

const controller = new AbortController();

// controller.abort()가 호출되면 재시도 작업이 중단됩니다.
const data = await retry(fetchData, { count: 5, signal: controller.signal });