함수: createRateLimiter()

function createRateLimiter<TFn, TSelected>(
   fn, 
   options, 
selector): SolidRateLimiter<TFn, TSelected>;

정의 위치: solid-pacer/src/rate-limiter/createRateLimiter.ts:185

함수 실행에 요청률 제한을 적용하는 RateLimiter 인스턴스를 생성하는 저수준 Solid 훅입니다.

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

요청률 제한은 시간 창 안에서 최대 횟수에 도달할 때까지 실행을 허용한 뒤, 창이 초기화될 때까지 모든 후속 호출을 차단하는 단순한 "하드 리밋" 방식입니다. 스로틀이나 디바운스와 달리 실행 간격을 조정하거나 지능적으로 병합하지 않습니다.

요청률 제한기는 두 가지 창 유형을 지원합니다.

• 'fixed': 창 기간이 지나면 초기화되는 엄격한 창입니다. 창 안의 모든 실행이 제한 횟수에 포함되며, 기간이 지나면 창이 완전히 초기화됩니다.
• 'sliding': 이전 실행이 만료되는 대로 새 실행을 허용하는 이동 창입니다. 시간에 따라 더 일관된 실행률을 제공합니다.

더 부드러운 실행 패턴이 필요하다면 다음을 사용합니다.

• 실행 사이에 일정한 간격이 필요할 때는 스로틀을 사용합니다(예: UI 업데이트).
• 빠르게 연속 발생하는 이벤트를 병합하려면 디바운스를 사용합니다(예: 검색 입력).
• 하드 리밋을 적용해야 할 때만 요청률 제한을 사용합니다(예: API 요청률 제한).

상태 관리와 셀렉터

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

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

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

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

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

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

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

• executionCount: 완료된 함수 실행 횟수
• rejectionCount: 요청률 제한으로 거부된 함수 호출 횟수
• remainingInWindow: 현재 창에 남은 실행 횟수
• nextWindowTime: 다음 창이 시작되는 시점의 타임스탬프
• currentWindowStart: 현재 창이 시작된 시점의 타임스탬프

타입 매개변수

TFn

TFn extends AnyFunction

TSelected

TSelected = { }

매개변수

fn

TFn

options

SolidRateLimiterOptions<TFn, TSelected>

selector

(state) => TSelected

반환값

SolidRateLimiter<TFn, TSelected>

예시

// Default behavior - no reactive state subscriptions
const rateLimiter = createRateLimiter(apiCall, {
  limit: 5,
  window: 60000,
  windowType: 'sliding',
});

// Subscribe to state changes deep in component tree using Subscribe component
<rateLimiter.Subscribe selector={(state) => ({ rejectionCount: state.rejectionCount })}>
  {(state) => (
    <div>Rejections: {state().rejectionCount}</div>
  )}
</rateLimiter.Subscribe>

// Opt-in to track execution count changes at hook level (optimized for tracking successful executions)
const rateLimiter = createRateLimiter(
  apiCall,
  {
    limit: 5,
    window: 60000,
    windowType: 'sliding',
  },
  (state) => ({ executionCount: state.executionCount })
);

// Opt-in to track rejection count changes (optimized for tracking rate limit violations)
const rateLimiter = createRateLimiter(
  apiCall,
  {
    limit: 5,
    window: 60000,
    windowType: 'sliding',
  },
  (state) => ({ rejectionCount: state.rejectionCount })
);

// Opt-in to track execution times changes (optimized for window calculations)
const rateLimiter = createRateLimiter(
  apiCall,
  {
    limit: 5,
    window: 60000,
    windowType: 'sliding',
  },
  (state) => ({ executionTimes: state.executionTimes })
);

// Multiple state properties - track when any of these change
const rateLimiter = createRateLimiter(
  apiCall,
  {
    limit: 5,
    window: 60000,
    windowType: 'sliding',
  },
  (state) => ({
    executionCount: state.executionCount,
    rejectionCount: state.rejectionCount
  })
);

// Monitor rate limit status
const handleClick = () => {
  const remaining = rateLimiter.getRemainingInWindow();
  if (remaining > 0) {
    rateLimiter.maybeExecute(data);
  } else {
    showRateLimitWarning();
  }
};

// Access the selected state (will be empty object {} unless selector provided)
const { executionCount, rejectionCount } = rateLimiter.state();