function useRateLimitedValue<TValue>(value, options): readonly [TValue, {
getExecutionCount: () => number;
getRejectionCount: () => number;
getRemainingInWindow: () => number;
maybeExecute: (...args) => boolean;
reset: () => void;
}]
function useRateLimitedValue<TValue>(value, options): readonly [TValue, {
getExecutionCount: () => number;
getRejectionCount: () => number;
getRemainingInWindow: () => number;
maybeExecute: (...args) => boolean;
reset: () => void;
}]
Defined in: react-pacer/src/rate-limiter/useRateLimitedValue.ts:52
A high-level React hook that creates a rate-limited version of a value that updates at most a certain number of times within a time window. This hook uses React's useState internally to manage the rate-limited state.
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 both the rate-limited value and the underlying rateLimiter instance for additional control.
For more direct control over rate limiting behavior without React state management, consider using the lower-level useRateLimiter hook instead.
• TValue
TValue
RateLimiterOptions
readonly [TValue, { getExecutionCount: () => number; getRejectionCount: () => number; getRemainingInWindow: () => number; maybeExecute: (...args) => boolean; reset: () => void; }]
// Basic rate limiting - update at most 5 times per minute
const [rateLimitedValue] = useRateLimitedValue(rawValue, {
limit: 5,
window: 60000
});
// With rejection callback
const [rateLimitedValue, rateLimiter] = useRateLimitedValue(rawValue, {
limit: 3,
window: 5000,
onReject: ({ msUntilNextWindow }) => {
console.log(`Update rejected. Try again in ${msUntilNextWindow}ms`);
}
});
// Optionally access rateLimiter methods
const handleSubmit = () => {
const remaining = rateLimiter.getRemainingInWindow();
if (remaining > 0) {
console.log(`${remaining} updates remaining in this window`);
} else {
console.log('Rate limit reached for this window');
}
};
// Basic rate limiting - update at most 5 times per minute
const [rateLimitedValue] = useRateLimitedValue(rawValue, {
limit: 5,
window: 60000
});
// With rejection callback
const [rateLimitedValue, rateLimiter] = useRateLimitedValue(rawValue, {
limit: 3,
window: 5000,
onReject: ({ msUntilNextWindow }) => {
console.log(`Update rejected. Try again in ${msUntilNextWindow}ms`);
}
});
// Optionally access rateLimiter methods
const handleSubmit = () => {
const remaining = rateLimiter.getRemainingInWindow();
if (remaining > 0) {
console.log(`${remaining} updates remaining in this window`);
} else {
console.log('Rate limit reached for this window');
}
};
Your weekly dose of JavaScript news. Delivered every Monday to over 100,000 devs, for free.