본문으로 건너뛰기

인터페이스: AsyncBatcherOptions<TValue>

정의 위치: async-batcher.ts:89

AsyncBatcher 인스턴스를 구성하기 위한 옵션입니다.

타입 매개변수​

TValue​

TValue

속성​

asyncRetryerOptions?​

optional asyncRetryerOptions: AsyncRetryerOptions<(items) => Promise<any>>;

정의 위치: async-batcher.ts:93

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

getShouldExecute()?​

optional getShouldExecute: (items, batcher) => boolean;

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

배치를 처리할지 결정하는 사용자 지정 함수입니다. true를 반환하면 배치를 즉시 처리합니다.

매개변수​

items​

TValue[]

batcher​

AsyncBatcher&lt;TValue>

반환값​

boolean

initialState?​

optional initialState: Partial<AsyncBatcherState<TValue>>;

정의 위치: async-batcher.ts:107

비동기 배처의 초기 상태입니다.

key?​

optional key: string;

정의 위치: async-batcher.ts:112

이 비동기 배처 인스턴스를 식별하는 선택적 키입니다. 이 키를 제공하면, 해당하는 경우 devtools와 PacerProvider에서 이 키로 비동기 배처를 식별합니다.

maxSize?​

optional maxSize: number;

정의 위치: async-batcher.ts:117

배치에 포함할 수 있는 최대 항목 수입니다.

기본값​

Infinity

onError()?​

optional onError: (error, batch, batcher) => void;

정의 위치: async-batcher.ts:123

배치 함수에서 오류를 던질 때 사용하는 선택적 오류 처리기입니다. 이 처리기를 제공하면 오류, 실패한 항목의 배치, 배처 인스턴스를 인자로 호출합니다. 이 옵션은 throwOnError와 함께 사용할 수 있으며, 오류를 던지기 전에 처리기를 호출합니다.

매개변수​

error​

Error

batch​

TValue[]

batcher​

AsyncBatcher&lt;TValue>

반환값​

void

onItemsChange()?​

optional onItemsChange: (batcher) => void;

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

항목이 배처에 추가된 후 실행되는 콜백입니다.

매개변수​

batcher​

AsyncBatcher&lt;TValue>

반환값​

void

onSettled()?​

optional onSettled: (batch, batcher) => void;

정의 위치: async-batcher.ts:135

배치 처리가 확정되었을 때(완료 또는 실패) 호출하는 선택적 콜백입니다.

매개변수​

batch​

TValue[]

batcher​

AsyncBatcher&lt;TValue>

반환값​

void

onSuccess()?​

optional onSuccess: (result, batch, batcher) => void;

정의 위치: async-batcher.ts:139

배치가 성공했을 때 호출하는 선택적 콜백입니다.

매개변수​

result​

any

batch​

TValue[]

batcher​

AsyncBatcher&lt;TValue>

반환값​

void

started?​

optional started: boolean;

정의 위치: async-batcher.ts:148

배처가 즉시 처리를 시작해야 하는지 여부입니다.

기본값​

true

throwOnError?​

optional throwOnError: boolean;

정의 위치: async-batcher.ts:154

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

wait?​

optional wait: number | (asyncBatcher) => number;

정의 위치: async-batcher.ts:161

배치를 처리하기 전에 대기할 최대 시간(밀리초)입니다. 대기 시간이 경과하면 배치를 처리합니다. 이 옵션을 제공하지 않으면 타임아웃으로 배치 처리가 트리거되지 않습니다.

기본값​

Infinity