본문으로 건너뛰기

인터페이스: AsyncThrottlerOptions<TFn>

정의 위치: async-throttler.ts:76

비동기 스로틀 함수를 구성하는 옵션입니다.

타입 매개변수​

TFn​

TFn은 AnyAsyncFunction을 확장합니다.

속성​

asyncRetryerOptions?​

optional asyncRetryerOptions: AsyncRetryerOptions<TFn>;

정의 위치: async-throttler.ts:80

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

enabled?​

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

정의 위치: async-throttler.ts:86

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

initialState?​

optional initialState: Partial<AsyncThrottlerState<TFn>>;

정의 위치: async-throttler.ts:90

비동기 스로틀러의 초기 상태입니다.

key?​

optional key: string;

정의 위치: async-throttler.ts:95

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

leading?​

optional leading: boolean;

정의 위치: async-throttler.ts:100

함수가 호출될 때 즉시 실행할지 여부입니다. 기본값은 true입니다.

onError()?​

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

정의 위치: async-throttler.ts:106

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

매개변수​

error​

Error

args​

Parameters&lt;TFn>

asyncThrottler​

AsyncThrottler&lt;TFn>

반환값​

void

onSettled()?​

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

정의 위치: async-throttler.ts:114

스로틀 함수가 실행될 때 호출할 선택적 함수입니다.

매개변수​

args​

Parameters&lt;TFn>

asyncThrottler​

AsyncThrottler&lt;TFn>

반환값​

void

onSuccess()?​

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

정의 위치: async-throttler.ts:121

스로틀 함수가 실행될 때 호출할 선택적 함수입니다.

매개변수​

result​

Awaited&lt;ReturnType&lt;TFn>>

args​

Parameters&lt;TFn>

asyncThrottler​

AsyncThrottler&lt;TFn>

반환값​

void

throwOnError?​

optional throwOnError: boolean;

정의 위치: async-throttler.ts:131

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

trailing?​

optional trailing: boolean;

정의 위치: async-throttler.ts:136

대기 기간의 후행 에지에서 함수를 실행할지 여부입니다. 기본값은 true입니다.

wait​

wait: number | (throttler) => number;

정의 위치: async-throttler.ts:142

함수를 한 번만 실행할 수 있는 시간 창의 길이이며, 단위는 밀리초입니다. number 값 또는 number를 반환하는 함수일 수 있습니다. 기본값은 0ms입니다.