UNPKG

wait-for-timers

Version:

Wait for queue of timers (e.g. requestAnimationFrame, requestIdleCallback, setTimeout) to complete before calling a callback

16 lines (15 loc) 588 B
declare type NonEmptyArray<T> = T[] & { 0: T; }; /** * Wait for a queue of sequential timers to complete before calling * a callback. Returns cancellation function to abort queue. * @param timerQueue Array of timers: * - "raf" -> requestAnimationFrame * - "ric" -> requestIdleCalback * - {number} -> setTimeout * @param onComplete Called after queue of timers completes * @returns Cancellation function that can be called to abort queue */ export default function waitForTimers(timerQueue: NonEmptyArray<'raf' | 'ric' | number>, onComplete: Function): () => void; export {};