본문으로 건너뛰기

인터페이스: RateLimiterOptions<TFn>

정의 위치: rate-limiter.ts:47

요청률이 제한된 함수를 구성하기 위한 옵션입니다.

타입 매개변수​

TFn​

TFn extends AnyFunction

속성​

enabled?​

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

정의 위치: rate-limiter.ts:52

요청률 제한기의 활성화 여부입니다. 비활성화되면 maybeExecute가 어떤 실행도 트리거하지 않습니다. 기본값은 true입니다.

initialState?​

optional initialState: Partial<RateLimiterState>;

정의 위치: rate-limiter.ts:56

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

key?​

optional key: string;

정의 위치: rate-limiter.ts:61

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

limit​

limit: number | (rateLimiter) => number;

정의 위치: rate-limiter.ts:66

시간 창 안에서 허용되는 최대 실행 횟수입니다. 숫자 또는 요청률 제한기 인스턴스를 받아 숫자를 반환하는 콜백 함수일 수 있습니다.

onExecute()?​

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

정의 위치: rate-limiter.ts:70

함수가 실행된 후 호출되는 콜백 함수입니다.

매개변수​

args​

Parameters&lt;TFn>

rateLimiter​

RateLimiter&lt;TFn>

반환값​

void

onReject()?​

optional onReject: (rateLimiter) => void;

정의 위치: rate-limiter.ts:74

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

매개변수​

rateLimiter​

RateLimiter&lt;TFn>

반환값​

void

window​

window: number | (rateLimiter) => number;

정의 위치: rate-limiter.ts:79

제한이 적용되는 시간 창(밀리초)입니다. 숫자 또는 요청률 제한기 인스턴스를 받아 숫자를 반환하는 콜백 함수일 수 있습니다.

windowType?​

optional windowType: "fixed" | "sliding";

정의 위치: rate-limiter.ts:86

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

  • 'fixed': 창 주기가 지나면 재설정되는 고정 창을 사용합니다.
  • 'sliding': 이전 실행이 만료됨에 따라 새로운 실행을 허용하는 슬라이딩 창을 사용합니다. 기본값은 'fixed'입니다.