createRateLimitedSignal

Function: createRateLimitedSignal()

function createRateLimitedSignal<TValue>(value, initialOptions): [Accessor<TValue>, Setter<TValue>, SolidRateLimiter<Setter<TValue>>]

function createRateLimitedSignal<TValue>(value, initialOptions): [Accessor<TValue>, Setter<TValue>, SolidRateLimiter<Setter<TValue>>]

Defined in: rate-limiter/createRateLimitedSignal.ts:65

A Solid hook that creates a rate-limited state value that enforces a hard limit on state updates within a time window. This hook combines Solid's createSignal with rate limiting functionality to provide controlled state updates.

Rate limiting is a simple "hard limit" approach - it allows all updates until the limit is reached, then blocks subsequent updates until the window resets. Unlike throttling or debouncing, it does not attempt to space out or intelligently collapse updates. This can lead to bursts of rapid updates followed by periods of no updates.

The rate limiter supports two types of windows:

'fixed': A strict window that resets after the window period. All updates within the window count towards the limit, and the window resets completely after the period.
'sliding': A rolling window that allows updates as old ones expire. This provides a more consistent rate of updates over time.

For smoother update patterns, consider:

createThrottledSignal: When you want consistent spacing between updates (e.g. UI changes)
createDebouncedSignal: When you want to collapse rapid updates into a single update (e.g. search input)

Rate limiting should primarily be used when you need to enforce strict limits, like API rate limits.

The hook returns a tuple containing:

The rate-limited state value accessor
A rate-limited setter function that respects the configured limits
The rateLimiter instance for additional control

For more direct control over rate limiting without state management, consider using the lower-level createRateLimiter hook instead.

// Basic rate limiting - update state at most 5 times per minute with a sliding window
const [value, setValue, rateLimiter] = createRateLimitedSignal(0, {
  limit: 5,
  window: 60000,
  windowType: 'sliding'
});

// With rejection callback and fixed window
const [value, setValue] = createRateLimitedSignal(0, {
  limit: 3,
  window: 5000,
  windowType: 'fixed',
  onReject: (rateLimiter) => {
    alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
  }
});

// Access rateLimiter state via signals
const handleSubmit = () => {
  const remaining = rateLimiter.remainingInWindow();
  if (remaining > 0) {
    setValue(newValue);
  } else {
    showRateLimitWarning();
  }
};

// Basic rate limiting - update state at most 5 times per minute with a sliding window
const [value, setValue, rateLimiter] = createRateLimitedSignal(0, {
  limit: 5,
  window: 60000,
  windowType: 'sliding'
});

// With rejection callback and fixed window
const [value, setValue] = createRateLimitedSignal(0, {
  limit: 3,
  window: 5000,
  windowType: 'fixed',
  onReject: (rateLimiter) => {
    alert(`Rate limit reached. Try again in ${rateLimiter.getMsUntilNextWindow()}ms`);
  }
});

// Access rateLimiter state via signals
const handleSubmit = () => {
  const remaining = rateLimiter.remainingInWindow();
  if (remaining > 0) {
    setValue(newValue);
  } else {
    showRateLimitWarning();
  }
};

createRateLimitedSignal

Function: createRateLimitedSignal()

Type Parameters

Parameters

value

initialOptions

Returns

Example

Subscribe to Bytes

Subscribe to Bytes