function useRateLimitedState<TValue>(value, options): readonly [TValue, (...args) => boolean, {
getExecutionCount: () => number;
getRejectionCount: () => number;
getRemainingInWindow: () => number;
maybeExecute: (...args) => boolean;
reset: () => void;
}]
function useRateLimitedState<TValue>(value, options): readonly [TValue, (...args) => boolean, {
getExecutionCount: () => number;
getRejectionCount: () => number;
getRemainingInWindow: () => number;
maybeExecute: (...args) => boolean;
reset: () => void;
}]
Defined in: react-pacer/src/rate-limiter/useRateLimitedState.ts:56
A React hook that creates a rate-limited state value that enforces a hard limit on state updates within a time window. This hook combines React's useState 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.
For smoother update patterns, consider:
Rate limiting should primarily be used when you need to enforce strict limits, like API rate limits.
The hook returns a tuple containing:
For more direct control over rate limiting without state management, consider using the lower-level useRateLimiter hook instead.
• TValue
TValue
RateLimiterOptions
readonly [TValue, (...args) => boolean, { getExecutionCount: () => number; getRejectionCount: () => number; getRemainingInWindow: () => number; maybeExecute: (...args) => boolean; reset: () => void; }]
// Basic rate limiting - update state at most 5 times per minute
const [value, setValue, rateLimiter] = useRateLimitedState(0, {
limit: 5,
window: 60000
});
// With rejection callback
const [value, setValue] = useRateLimitedState(0, {
limit: 3,
window: 5000,
onReject: ({ msUntilNextWindow }) => {
alert(`Rate limit reached. Try again in ${msUntilNextWindow}ms`);
}
});
// Access rateLimiter methods if needed
const handleSubmit = () => {
const remaining = rateLimiter.getRemainingInWindow();
if (remaining > 0) {
setValue(newValue);
} else {
showRateLimitWarning();
}
};
// Basic rate limiting - update state at most 5 times per minute
const [value, setValue, rateLimiter] = useRateLimitedState(0, {
limit: 5,
window: 60000
});
// With rejection callback
const [value, setValue] = useRateLimitedState(0, {
limit: 3,
window: 5000,
onReject: ({ msUntilNextWindow }) => {
alert(`Rate limit reached. Try again in ${msUntilNextWindow}ms`);
}
});
// Access rateLimiter methods if needed
const handleSubmit = () => {
const remaining = rateLimiter.getRemainingInWindow();
if (remaining > 0) {
setValue(newValue);
} else {
showRateLimitWarning();
}
};
Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.