File: rateLimit.md | Updated: 11/15/2025
Search...
+ K
Auto
Docs Examples GitHub Contributors
Docs Examples GitHub Contributors
Docs Examples GitHub Contributors
Docs Examples Github Contributors
Docs Examples Github Contributors
Docs Examples Github Contributors
Docs Examples Github Contributors
Docs Examples Github Contributors
Maintainers Partners Support Learn StatsBETA Discord Merch Blog GitHub Ethos Brand Guide
Documentation
Framework
Solid
Version
Latest
Search...
+ K
Menu
Getting Started
Guides
API Reference
Debouncer API Reference
Throttler API Reference
Rate Limiter API Reference
Queue API Reference
Batcher API Reference
Debouncer Examples
Throttler Examples
Rate Limiter Examples
Queue Examples
Batcher Examples
Framework
Solid
Version
Latest
Menu
Getting Started
Guides
API Reference
Debouncer API Reference
Throttler API Reference
Rate Limiter API Reference
Queue API Reference
Batcher API Reference
Debouncer Examples
Throttler Examples
Rate Limiter Examples
Queue Examples
Batcher Examples
Solid Example: RateLimit
=============================================================================================================================================================================================================================================================================================================================================================================================================
Code ExplorerCode
Interactive SandboxSandbox
public
src
.eslintrc.cjs
.gitignore
README.md
index.html
package.json
tsconfig.json
vite.config.ts
tsx
import { createSignal } from 'solid-js'
import { render } from 'solid-js/web'
import { rateLimit } from '@tanstack/solid-pacer/rate-limiter'
function App1() {
const [windowType, setWindowType] = createSignal<'fixed' | 'sliding'>('fixed')
// Use your state management library of choice
const [instantCount, setInstantCount] = createSignal(0)
const [rateLimitedCount, setRateLimitedCount] = createSignal(0)
// Create rate-limited setter function - Stable reference required!
const rateLimitedSetCount = rateLimit(setRateLimitedCount, {
limit: 5,
window: 5000,
windowType: windowType(),
onReject: (rateLimiter) =>
console.log(
'Rejected by rate limiter',
rateLimiter.getMsUntilNextWindow(),
),
})
function increment() {
// this pattern helps avoid common bugs with stale closures and state
setInstantCount((c) => {
const newInstantCount = c + 1 // common new value for both
rateLimitedSetCount(newInstantCount) // rate-limited state update
return newInstantCount // instant state update
})
}
return (
<div>
<h1>TanStack Pacer rateLimit Example 1</h1>
<div style={{ display: 'grid', gap: '0.5rem', 'margin-bottom': '1rem' }}>
<label>
<input
type="radio"
name="windowType"
value="fixed"
checked={windowType() === 'fixed'}
onChange={() => setWindowType('fixed')}
/>
Fixed Window
</label>
<label>
<input
type="radio"
name="windowType"
value="sliding"
checked={windowType() === 'sliding'}
onChange={() => setWindowType('sliding')}
/>
Sliding Window
</label>
</div>
<table>
<tbody>
<tr>
<td>Instant Count:</td>
<td>{instantCount()}</td>
</tr>
<tr>
<td>Rate Limited Count:</td>
<td>{rateLimitedCount()}</td>
</tr>
</tbody>
</table>
<div>
<button onClick={increment}>Increment</button>
</div>
</div>
)
}
function App2() {
const [windowType, setWindowType] = createSignal<'fixed' | 'sliding'>('fixed')
const [text, setText] = createSignal('')
const [rateLimitedText, setRateLimitedText] = createSignal('')
// Create rate-limited setter function - Stable reference required!
const rateLimitedSetText = rateLimit(setRateLimitedText, {
limit: 5,
window: 5000,
windowType: windowType(),
onReject: (rateLimiter) =>
console.log(
'Rejected by rate limiter',
rateLimiter.getMsUntilNextWindow(),
),
})
function handleTextChange(e: Event) {
const target = e.target as HTMLInputElement
const newValue = target.value
setText(newValue)
rateLimitedSetText(newValue)
}
return (
<div>
<h1>TanStack Pacer rateLimit Example 2</h1>
<div style={{ display: 'grid', gap: '0.5rem', 'margin-bottom': '1rem' }}>
<label>
<input
type="radio"
name="windowType2"
value="fixed"
checked={windowType() === 'fixed'}
onChange={() => setWindowType('fixed')}
/>
Fixed Window
</label>
<label>
<input
type="radio"
name="windowType2"
value="sliding"
checked={windowType() === 'sliding'}
onChange={() => setWindowType('sliding')}
/>
Sliding Window
</label>
</div>
<div>
<input
autofocus
type="search"
value={text()}
onInput={handleTextChange}
placeholder="Type text (rate limited to 3 updates per 5 seconds)..."
style={{ width: '100%' }}
/>
</div>
<table>
<tbody>
<tr>
<td>Instant Text:</td>
<td>{text()}</td>
</tr>
<tr>
<td>Rate Limited Text:</td>
<td>{rateLimitedText()}</td>
</tr>
</tbody>
</table>
</div>
)
}
function App3() {
const [windowType, setWindowType] = createSignal<'fixed' | 'sliding'>('fixed')
const [currentValue, setCurrentValue] = createSignal(50)
const [rateLimitedValue, setRateLimitedValue] = createSignal(50)
// Create rate-limited setter function - Stable reference required!
const rateLimitedSetValue = rateLimit(setRateLimitedValue, {
limit: 20,
window: 2000,
windowType: windowType(),
onReject: (rateLimiter) =>
console.log(
'Rejected by rate limiter',
rateLimiter.getMsUntilNextWindow(),
),
})
function handleRangeChange(e: Event) {
const target = e.target as HTMLInputElement
const newValue = parseInt(target.value, 10)
setCurrentValue(newValue)
rateLimitedSetValue(newValue)
}
return (
<div>
<h1>TanStack Pacer rateLimit Example 3</h1>
<div style={{ display: 'grid', gap: '0.5rem', 'margin-bottom': '1rem' }}>
<label>
<input
type="radio"
name="windowType3"
value="fixed"
checked={windowType() === 'fixed'}
onChange={() => setWindowType('fixed')}
/>
Fixed Window
</label>
<label>
<input
type="radio"
name="windowType3"
value="sliding"
checked={windowType() === 'sliding'}
onChange={() => setWindowType('sliding')}
/>
Sliding Window
</label>
</div>
<div style={{ 'margin-bottom': '20px' }}>
<label>
Current Range:
<input
type="range"
min="0"
max="100"
value={currentValue()}
onInput={handleRangeChange}
style={{ width: '100%' }}
/>
<span>{currentValue()}</span>
</label>
</div>
<div style={{ 'margin-bottom': '20px' }}>
<label>
Rate Limited Range (Readonly):
<input
type="range"
min="0"
max="100"
value={rateLimitedValue()}
readOnly
style={{ width: '100%' }}
/>
<span>{rateLimitedValue()}</span>
</label>
</div>
<div style={{ color: '#666', 'font-size': '0.9em' }}>
<p>Rate limited to 20 updates per 2 seconds</p>
</div>
</div>
)
}
render(
() => (
<div>
<App1 />
<hr />
<App2 />
<hr />
<App3 />
</div>
),
document.getElementById('root')!,
)
import { createSignal } from 'solid-js'
import { render } from 'solid-js/web'
import { rateLimit } from '@tanstack/solid-pacer/rate-limiter'
function App1() {
const [windowType, setWindowType] = createSignal<'fixed' | 'sliding'>('fixed')
// Use your state management library of choice
const [instantCount, setInstantCount] = createSignal(0)
const [rateLimitedCount, setRateLimitedCount] = createSignal(0)
// Create rate-limited setter function - Stable reference required!
const rateLimitedSetCount = rateLimit(setRateLimitedCount, {
limit: 5,
window: 5000,
windowType: windowType(),
onReject: (rateLimiter) =>
console.log(
'Rejected by rate limiter',
rateLimiter.getMsUntilNextWindow(),
),
})
function increment() {
// this pattern helps avoid common bugs with stale closures and state
setInstantCount((c) => {
const newInstantCount = c + 1 // common new value for both
rateLimitedSetCount(newInstantCount) // rate-limited state update
return newInstantCount // instant state update
})
}
return (
<div>
<h1>TanStack Pacer rateLimit Example 1</h1>
<div style={{ display: 'grid', gap: '0.5rem', 'margin-bottom': '1rem' }}>
<label>
<input
type="radio"
name="windowType"
value="fixed"
checked={windowType() === 'fixed'}
onChange={() => setWindowType('fixed')}
/>
Fixed Window
</label>
<label>
<input
type="radio"
name="windowType"
value="sliding"
checked={windowType() === 'sliding'}
onChange={() => setWindowType('sliding')}
/>
Sliding Window
</label>
</div>
<table>
<tbody>
<tr>
<td>Instant Count:</td>
<td>{instantCount()}</td>
</tr>
<tr>
<td>Rate Limited Count:</td>
<td>{rateLimitedCount()}</td>
</tr>
</tbody>
</table>
<div>
<button onClick={increment}>Increment</button>
</div>
</div>
)
}
function App2() {
const [windowType, setWindowType] = createSignal<'fixed' | 'sliding'>('fixed')
const [text, setText] = createSignal('')
const [rateLimitedText, setRateLimitedText] = createSignal('')
// Create rate-limited setter function - Stable reference required!
const rateLimitedSetText = rateLimit(setRateLimitedText, {
limit: 5,
window: 5000,
windowType: windowType(),
onReject: (rateLimiter) =>
console.log(
'Rejected by rate limiter',
rateLimiter.getMsUntilNextWindow(),
),
})
function handleTextChange(e: Event) {
const target = e.target as HTMLInputElement
const newValue = target.value
setText(newValue)
rateLimitedSetText(newValue)
}
return (
<div>
<h1>TanStack Pacer rateLimit Example 2</h1>
<div style={{ display: 'grid', gap: '0.5rem', 'margin-bottom': '1rem' }}>
<label>
<input
type="radio"
name="windowType2"
value="fixed"
checked={windowType() === 'fixed'}
onChange={() => setWindowType('fixed')}
/>
Fixed Window
</label>
<label>
<input
type="radio"
name="windowType2"
value="sliding"
checked={windowType() === 'sliding'}
onChange={() => setWindowType('sliding')}
/>
Sliding Window
</label>
</div>
<div>
<input
autofocus
type="search"
value={text()}
onInput={handleTextChange}
placeholder="Type text (rate limited to 3 updates per 5 seconds)..."
style={{ width: '100%' }}
/>
</div>
<table>
<tbody>
<tr>
<td>Instant Text:</td>
<td>{text()}</td>
</tr>
<tr>
<td>Rate Limited Text:</td>
<td>{rateLimitedText()}</td>
</tr>
</tbody>
</table>
</div>
)
}
function App3() {
const [windowType, setWindowType] = createSignal<'fixed' | 'sliding'>('fixed')
const [currentValue, setCurrentValue] = createSignal(50)
const [rateLimitedValue, setRateLimitedValue] = createSignal(50)
// Create rate-limited setter function - Stable reference required!
const rateLimitedSetValue = rateLimit(setRateLimitedValue, {
limit: 20,
window: 2000,
windowType: windowType(),
onReject: (rateLimiter) =>
console.log(
'Rejected by rate limiter',
rateLimiter.getMsUntilNextWindow(),
),
})
function handleRangeChange(e: Event) {
const target = e.target as HTMLInputElement
const newValue = parseInt(target.value, 10)
setCurrentValue(newValue)
rateLimitedSetValue(newValue)
}
return (
<div>
<h1>TanStack Pacer rateLimit Example 3</h1>
<div style={{ display: 'grid', gap: '0.5rem', 'margin-bottom': '1rem' }}>
<label>
<input
type="radio"
name="windowType3"
value="fixed"
checked={windowType() === 'fixed'}
onChange={() => setWindowType('fixed')}
/>
Fixed Window
</label>
<label>
<input
type="radio"
name="windowType3"
value="sliding"
checked={windowType() === 'sliding'}
onChange={() => setWindowType('sliding')}
/>
Sliding Window
</label>
</div>
<div style={{ 'margin-bottom': '20px' }}>
<label>
Current Range:
<input
type="range"
min="0"
max="100"
value={currentValue()}
onInput={handleRangeChange}
style={{ width: '100%' }}
/>
<span>{currentValue()}</span>
</label>
</div>
<div style={{ 'margin-bottom': '20px' }}>
<label>
Rate Limited Range (Readonly):
<input
type="range"
min="0"
max="100"
value={rateLimitedValue()}
readOnly
style={{ width: '100%' }}
/>
<span>{rateLimitedValue()}</span>
</label>
</div>
<div style={{ color: '#666', 'font-size': '0.9em' }}>
<p>Rate limited to 20 updates per 2 seconds</p>
</div>
</div>
)
}
render(
() => (
<div>
<App1 />
<hr />
<App2 />
<hr />
<App3 />
</div>
),
document.getElementById('root')!,
)
