Class Timing

Provides timing related higher-order functions.

This class should not be constructed as it only contains static methods.

Index

Constructors

Methods

debounce doubleClick

Constructors

constructor

new Timing(): Timing
Returns Timing

Methods

`Static`debounce

debounce<Args>(
callback: (...args: Args[]) => void,
delay: number,
): (...args: Args[]) => void
Wraps a callback in a debounced timeout. Delay execution of the callback function until the function has not been called for the given delay in milliseconds.
Type Parameters
- Args
Parameters
- callback: (...args: Args[]) => void
  A function to execute once the debounced threshold has been passed.
- delay: number
  An amount of time in milliseconds to delay.
Returns (...args: Args[]) => void
A wrapped function that can be called to debounce execution.
Example
```
/**
 * Debounce the update invocation by 500ms.
 */
const updateDebounced = Timing.debounce(() => doc.update(), 500);

// Use the function like:
updateDebounced();
```
Example
```
/**
 * Debounce the update invocation by 500ms.
 *
 * @param {string} value - A value to update.
 */
const updateDebounced = Timing.debounce((value) => doc.update(value), 500);

// Use the function like:
updateDebounced('new value');
```

`Static`doubleClick

doubleClick(
    opts: {
        delay?: number;
        double?: (event: Event) => void;
        single?: (event: Event) => void;
    },
): (event: Event) => void
Creates a double click event handler that distinguishes between single and double clicks. Calls the single callback on a single click and the double callback on a double click. The default double click delay to invoke the double callback is 400 milliseconds.
Parameters
- opts: {
      delay?: number;
      double?: (event: Event) => void;
      single?: (event: Event) => void;
  }
  Optional parameters.
  - Optionaldelay?: number
    Double click delay.
  - Optionaldouble?: (event: Event) => void
    Double click callback.
  - Optionalsingle?: (event: Event) => void
    Single click callback.
Returns (event: Event) => void
The gated double-click handler.
Example
```
// Given a button element.
button.addEventListener('click', Timing.doubleClick({
   single: (event) => console.log('Single click: ', event),
   double: (event) => console.log('Double click: ', event)
});
```