Powered by Mintlify
Auto-generate your docs
Limit the rate of function calls using token bucket algorithm
Documentation Index
Fetch the complete documentation index at: https://mintlify.com/visible/cruel/llms.txt
Use this file to discover all available pages before exploring further.
function createRateLimiter<T extends AnyFn>(
fn: T,
options: RateLimiterOptions
): T
CruelRateLimitError when rate limit is exceeded.
interface RateLimiterOptions {
requests: number
interval: number
onLimit?: () => void
}
import { createRateLimiter, CruelRateLimitError } from 'cruel'
const rateLimitedFetch = createRateLimiter(
async (url: string) => {
const response = await fetch(url)
return response.json()
},
{
requests: 10,
interval: 60000, // 10 requests per minute
onLimit: () => {
console.warn('Rate limit exceeded')
}
}
)
try {
const data = await rateLimitedFetch('https://api.example.com/data')
} catch (error) {
if (error instanceof CruelRateLimitError) {
console.log(`Rate limited. Retry after ${error.retryAfter}s`)
}
}