Function: throttle()

function throttle<T>(
  fn: T,
  delay: number,
  options?: {
    leading: boolean;
    trailing: boolean;
  },
): {
  (...args: Parameters<T>): void | ReturnType<T>;
  clear: () => void;
  immediate: T;
};

Type Parameters

Type Parameter
T extends (...args: any[]) => any

Parameters

Parameter	Type
fn	T
delay	number
options?	{ leading: boolean; trailing: boolean; }
options.leading?	boolean
options.trailing?	boolean

Returns

(...args: Parameters<T>):
  | void
| ReturnType<T>;

Parameters

Parameter	Type
...args	Parameters<T>

Returns

| void | ReturnType<T>

Name	Type
clear()	() => void
immediate	T