본문으로 건너뛰기

인터페이스: AsyncRateLimiterOptions<TFn>

정의 위치: async-rate-limiter.ts:71

비동기 요청률 제한 함수를 구성하는 옵션입니다.

타입 매개변수​

TFn​

TFn은 AnyAsyncFunction을 확장합니다.

속성​

asyncRetryerOptions?​

optional asyncRetryerOptions: AsyncRetryerOptions<TFn>;

정의 위치: async-rate-limiter.ts:75

내부 비동기 재시도기를 구성하는 옵션입니다.

enabled?​

optional enabled: boolean | (rateLimiter) => boolean;

정의 위치: async-rate-limiter.ts:81

요청률 제한기의 활성화 여부입니다. 비활성화되면 maybeExecute가 어떤 실행도 트리거하지 않습니다. boolean 값 또는 boolean을 반환하는 함수일 수 있습니다. 기본값은 true입니다.

initialState?​

optional initialState: Partial<AsyncRateLimiterState<TFn>>;

정의 위치: async-rate-limiter.ts:85

요청률 제한기의 초기 상태입니다.

key?​

optional key: string;

정의 위치: async-rate-limiter.ts:90

이 비동기 요청률 제한기 인스턴스를 식별하는 선택적 키입니다. 제공하면 해당하는 경우 개발자 도구와 PacerProvider에서 이 키로 비동기 요청률 제한기를 식별합니다.

limit​

limit: number | (rateLimiter) => number;

정의 위치: async-rate-limiter.ts:95

시간 창 내에서 허용되는 최대 실행 횟수입니다. number 값 또는 number를 반환하는 함수일 수 있습니다.

onError()?​

optional onError: (error, args, rateLimiter) => void;

정의 위치: async-rate-limiter.ts:101

요청률 제한 함수가 오류를 던질 때 사용하는 선택적 오류 핸들러입니다. 제공하면 오류 및 요청률 제한기 인스턴스와 함께 핸들러가 호출됩니다. throwOnError와 함께 사용할 수 있으며, 오류를 던지기 전에 핸들러가 호출됩니다.

매개변수​

error​

Error

args​

Parameters&lt;TFn>

rateLimiter​

AsyncRateLimiter&lt;TFn>

반환값​

void

onReject()?​

optional onReject: (args, rateLimiter) => void;

정의 위치: async-rate-limiter.ts:109

요청률 제한으로 인해 실행이 거부될 때 호출되는 선택적 콜백 함수입니다.

매개변수​

args​

Parameters&lt;TFn>

rateLimiter​

AsyncRateLimiter&lt;TFn>

반환값​

void

onSettled()?​

optional onSettled: (args, rateLimiter) => void;

정의 위치: async-rate-limiter.ts:113

요청률 제한 함수가 실행될 때 호출할 선택적 함수입니다.

매개변수​

args​

Parameters&lt;TFn>

rateLimiter​

AsyncRateLimiter&lt;TFn>

반환값​

void

onSuccess()?​

optional onSuccess: (result, args, rateLimiter) => void;

정의 위치: async-rate-limiter.ts:120

요청률 제한 함수가 실행될 때 호출할 선택적 함수입니다.

매개변수​

result​

Awaited&lt;ReturnType&lt;TFn>>

args​

Parameters&lt;TFn>

rateLimiter​

AsyncRateLimiter&lt;TFn>

반환값​

void

throwOnError?​

optional throwOnError: boolean;

정의 위치: async-rate-limiter.ts:130

오류가 발생할 때 오류를 던질지 여부입니다. onError 핸들러를 제공하지 않으면 기본값은 true이고, 제공하면 false입니다. 이 기본값을 재정의하도록 명시적으로 설정할 수 있습니다.

window​

window: number | (rateLimiter) => number;

정의 위치: async-rate-limiter.ts:135

제한이 적용되는 시간 창의 길이이며, 단위는 밀리초입니다. number 값 또는 number를 반환하는 함수일 수 있습니다.

windowType?​

optional windowType: "fixed" | "sliding";

정의 위치: async-rate-limiter.ts:142

요청률 제한에 사용할 창 유형입니다.

  • 'fixed': 창 기간이 지나면 초기화되는 고정 창을 사용합니다.
  • 'sliding': 이전 실행 기록이 만료되는 대로 새 실행을 허용하는 슬라이딩 창을 사용합니다. 기본값은 'fixed'입니다.