Function acquireRateLimit

  • acquireRateLimit(onRetryFailed?: (error: Error) => void): Promise<void>

    Acquire a rate limit slot for making a request.

    Queues the request and starts the processor if inactive. Blocks until it's safe to make the request based on rate limit intervals.

    Parameters

    • OptionalonRetryFailed: (error: Error) => void

      Optional callback invoked if retries are exhausted after transient errors.

    Returns Promise<void>

    Promise that resolves when rate limit permits the request.

    Source

    export async function acquireRateLimit(
      onRetryFailed?: (error: Error) => void,
    ): Promise<void> {
      return new Promise<void>((resolve) => {
        // Queue this request with initial retry tracking
        requestQueue.push({
          resolve,
          attempt: 0,
          maxAttempts: MAX_RETRIES,
          nextEligibleAt: Date.now(),
          onRetryFailed,
        });

        // Start processing if not already active
        if (!isProcessingQueue()) {
          processRateLimitQueue();
        }
      });
    }

Settings

Member Visibility