UNPKG

clientnode

Version:

upgrade to object orientated rock solid plugins

torben.website/clientnode

thaibault/clientnode

31 lines (30 loc) • 1.69 kB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
import { TimeoutPromise } from './type'; /** * Prevents event functions from triggering to often by defining a minimal * span between each function call. Additional arguments given to this * function will be forwarded to given event function call. * @param callback - The function to call debounced. * @param thresholdInMilliseconds - The minimum time span between each * function call. * @param additionalArguments - Additional arguments to forward to given * function. * @returns Returns the wrapped method. */ export declare const debounce: <T = unknown>(callback: (...parameters: Array<unknown>) => T, thresholdInMilliseconds?: number, ...additionalArguments: Array<unknown>) => ((...parameters: Array<unknown>) => Promise<T>); /** * Triggers given callback after given duration. Supports unlimited * duration length and returns a promise which will be resolved after given * duration has been passed. * @param parameters - Observes the first three existing parameters. If one * is a number it will be interpreted as delay in milliseconds until given * callback will be triggered. If one is of type function it will be used * as callback and if one is of type boolean it will indicate if returning * promise should be rejected or resolved if given internally created * timeout should be canceled. Additional parameters will be forwarded to * given callback. * @returns A promise resolving after given delay or being rejected if * value "true" is within one of the first three parameters. The promise * holds a boolean indicating whether timeout has been canceled or * resolved. */ export declare const timeout: (...parameters: Array<unknown>) => TimeoutPromise;