본문으로 건너뛰기

함수: createAsyncThrottler()

function createAsyncThrottler<TFn, TSelected>(
   fn, 
   options, 
selector): SolidAsyncThrottler<TFn, TSelected>;

정의 위치: solid-pacer/src/async-throttler/createAsyncThrottler.ts:175

비동기 함수의 실행 빈도를 제한하는 AsyncThrottler 인스턴스를 생성하는 저수준 Solid 훅입니다.

유연하고 상태 관리 방식에 구애받지 않도록 설계되었습니다. 스로틀러 인스턴스만 반환하므로 createSignal 등 원하는 상태 관리 솔루션과 통합할 수 있습니다.

비동기 스로틀은 호출 횟수와 관계없이 지정된 시간 윈도우 안에서 비동기 함수가 최대 한 번만 실행되도록 합니다. 비용이 큰 API 호출, 데이터베이스 작업 또는 기타 비동기 작업의 요청률을 제한할 때 유용합니다.

비동기가 아닌 Throttler와 달리 이 비동기 버전은 스로틀된 함수의 값을 반환할 수 있습니다. 따라서 디바운스된 함수 안에서 결과를 상태 변수에 설정하는 대신 maybeExecute 호출 결과를 사용하려는 API 호출 및 기타 비동기 작업에 적합합니다.

오류 처리:

  • onError 핸들러를 제공하면 오류 및 스로틀러 인스턴스와 함께 호출됩니다.
  • throwOnError가 true이면(onError 핸들러가 없을 때의 기본값) 오류가 발생합니다.
  • throwOnError가 false이면(onError 핸들러가 있을 때의 기본값) 오류가 처리된 것으로 간주됩니다.
  • onError와 throwOnError를 함께 사용할 수 있으며, 오류가 발생하기 전에 핸들러가 호출됩니다.
  • 내부 AsyncThrottler 인스턴스를 사용해 오류 상태를 확인할 수 있습니다.

상태 관리와 셀렉터​

훅은 반응형 상태 관리에 TanStack Store를 사용합니다. 다음 두 가지 방식으로 상태 변경을 구독할 수 있습니다. 구독 방식은 다음과 같습니다.

1. throttler.Subscribe 컴포넌트 사용(컴포넌트 트리 구독에 권장)

Subscribe 컴포넌트를 사용하면 컴포넌트 트리 깊은 곳에서 상태 변경을 구독하면서도 훅에 셀렉터를 전달할 필요가 없습니다. 자식 컴포넌트에서 상태를 구독하려는 경우에 적합합니다.

2. selector 매개변수 사용(훅 수준 구독)

selector 매개변수로 반응형 업데이트를 트리거할 상태 변경을 지정할 수 있으며, 훅 수준에서 관련 없는 상태가 변경될 때 불필요한 업데이트를 방지하여 성능을 최적화합니다.

기본적으로 반응형 상태 구독은 없습니다. 반응형 상태를 추적하려면 셀렉터 함수를 제공하여 셀렉터 함수를 제공하거나 Subscribe 컴포넌트를 사용해 명시적으로 활성화해야 합니다. 이를 통해 불필요한 업데이트를 방지하고 컴포넌트가 상태 변경을 추적할 시점을 완전히 제어할 수 있습니다.

사용할 수 있는 상태 속성은 다음과 같습니다.

  • canLeadingExecute: 스로틀러가 선행 에지에서 실행될 수 있는지 여부
  • canTrailingExecute: 스로틀러가 후행 에지에서 실행될 수 있는지 여부
  • executionCount: 완료된 함수 실행 횟수
  • hasError: 마지막 실행에서 오류가 발생했는지 여부
  • isPending: 스로틀러가 타임아웃 후 실행되기를 기다리고 있는지 여부
  • isExecuting: 현재 비동기 함수 실행이 진행 중인지 여부
  • lastArgs: 가장 최근 maybeExecute 호출에 전달된 인수
  • lastError: 가장 최근 실패한 실행의 오류(있는 경우)
  • lastExecutionTime: 마지막 실행의 타임스탬프
  • lastResult: 가장 최근에 성공한 실행 결과
  • nextExecutionTime: 다음 실행이 허용되는 시점의 타임스탬프
  • status: 현재 실행 상태('disabled' | 'idle' | 'pending' | 'executing')

언마운트 동작​

기본적으로 소유 컴포넌트가 마운트 해제되면 대기 중인 실행을 취소하고 진행 중인 실행을 중단합니다. getAbortSignal()의 중단 신호를 내부 작업(예: fetch)에 전달한 경우에만 Abort가 해당 작업을 취소합니다. onUnmount 옵션으로 이 동작을 사용자 지정할 수 있습니다. 예를 들어 대기 중인 작업을 대신 플러시하려면 다음과 같이 설정합니다.

const throttler = createAsyncThrottler(fn, {
  wait: 1000,
  onUnmount: (t) => t.flush()
});

참고: 비동기 유틸리티에서 flush()는 Promise를 반환하며 정리 과정에서는 실행 후 결과를 기다리지 않습니다. throttled 함수가 Solid 시그널을 업데이트하면 해당 업데이트는 컴포넌트가 마운트 해제된 후 실행될 수 있으며 예상치 못한 반응형 업데이트가 발생할 수 있습니다. 따라서 onUnmount에서 flush를 사용할 때는 콜백을 적절히 보호해야 합니다.

타입 매개변수​

TFn​

TFn extends AnyAsyncFunction

TSelected​

TSelected = { }

매개변수​

fn​

TFn

options​

SolidAsyncThrottlerOptions&lt;TFn, TSelected>

selector​

(state) => TSelected

반환값​

SolidAsyncThrottler&lt;TFn, TSelected>

예시​

// Default behavior - no reactive state subscriptions
const { maybeExecute } = createAsyncThrottler(
  async (id: string) => {
    const data = await api.fetchData(id);
    return data;
  },
  { wait: 1000 }
);

// Opt-in to track isPending or isExecuting changes (optimized for loading states)
const throttler = createAsyncThrottler(
  async (query) => {
    const result = await searchAPI(query);
    return result;
  },
  { wait: 2000 },
  (state) => ({ isPending: state.isPending, isExecuting: state.isExecuting })
);

// Opt-in to track error state changes (optimized for error handling)
const throttler = createAsyncThrottler(
  async (query) => {
    const result = await searchAPI(query);
    return result;
  },
  {
    wait: 2000,
    leading: true,   // Execute immediately on first call
    trailing: false, // Skip trailing edge updates
    onError: (error) => {
      console.error('API call failed:', error);
    }
  },
  (state) => ({ hasError: state.hasError, lastError: state.lastError })
);

// Access the selected state (will be empty object {} unless selector provided)
const { isPending, isExecuting } = throttler.state();