xdash API Reference v0.5.14

---

xdash API Reference / throttle

Function: throttle()

throttle<Args>(fn, ms, options): (...args) => void

Defined in: src/function.ts:130

Throttles a function.

Type Parameters

Args

Args extends readonly unknown[]

Parameters

fn

(...args) => void

function to throttle

ms

number

time in milliseconds to throttle the function

options

options to configure the throttle

leading?

boolean = true

whether to run the function on the leading edge

trailing?

boolean = true

whether to run the function on the trailing edge

Returns

a throttled function

(...args): void

Parameters

args

...Args

Returns

void

Examples

const log = throttle(console.log, 1000)
log('foo') // logs 'foo'
log('bar') // does not log 'bar'
log('baz') // does not log 'baz'
setTimeout(() => log('qux'), 1000) // logs 'qux' after 1 second

const log = throttle(console.log, 1000, { leading: false, trailing: true })
log('foo') // does not log 'foo'
log('bar') // does not log 'bar'
log('baz') // does not log 'baz'
setTimeout(() => log('qux'), 1000) // logs 'qux' after 1 second

const log = throttle(console.log, 1000, { leading: true, trailing: false })
log('foo') // logs 'foo'
log('bar') // does not log 'bar'
log('baz') // does not log 'baz'
setTimeout(() => log('qux'), 1000) // does not log 'qux'

const log = throttle(console.log, 1000, { leading: false, trailing: false })
log('foo') // does not log 'foo'
log('bar') // does not log 'bar'
log('baz') // does not log 'baz'
setTimeout(() => log('qux'), 1000) // does not log 'qux'