throttle

• throttle

节流函数用于限制函数调用的频率。它确保函数在指定的时间间隔内不会被多次调用。

Added in v0.0.1

Usage

import { throttle } from 'parsnip-kit'

const handler = () => console.log('Function called')

// Basic throttle usage
const throttled = throttle(handler, 300)
throttled() // console.log is called after 300ms
throttled() // Call is ignored due to throttle

// Throttle with leading and trailing options
const throttledWithOptions = throttle(handler, 300, { leading: true, trailing: true })
throttledWithOptions() // console.log is called immediately and again after 300ms if no other calls are made.

API

Type Parameter

Arg	Type	Description
T	extends (...args: any[]) => any	要节流的函数类型

Arguments

Arg	Type	Optional	Default	Description
func	T	false	undefined	要节流的函数
wait	number	false	undefined	The minimum allowed interval between two consecutive calls (in milliseconds).
options	object	true	undefined	可选参数对象
options.leading	boolean	true	false	是否在等待间隔开始时执行函数
options.trailing	boolean	true	true	是否在等待间隔结束时执行函数

Returns

Type
(...args: Parameters<T>) => void