Skip to content
On this page

throttle

Prevents function execution for a stated time period after it was last called.

Usage

ts
import { throttle } from '@screaming/utils'

const ribbit = throttle(() => {
  console.log('ribbit')
}, 1000)
// can only log once per 1000ms
1
2
3
4
5
6

Type Definitions

ts
/**
 * @param fn - The function.
 * @param limit - The time period.
 * @returns The throttled function.
 */
export declare function throttle(
  fn: (...args: any[]) => void,
  limit: number
): (...args: any[]) => void
1
2
3
4
5
6
7
8
9