web-browser-timer

A wrapper around setTimeout/clearTimeout for better API interface and testing.

Also it fixes setTimeout's bug when it fires the callback immediately if the delay is larger than about 28 days.

Install

npm install web-browser-timer --save

Use

Browser

import { Timer } from 'web-browser-timer'

const timer = new Timer()

// Analogous to `setTimeout()`.
const timerId = timer.schedule(func, delay)

// Analogous to `clearTimeout()`.
timer.cancel(timerId)

// Analogous to `Date.now()`.
timer.now()

// Waits for a specified time amount, in milliseconds.
timer.waitFor(1000)

TestTimer

TestTimer could be used in place of Timer in tests.

TestTimer accepts constructor arguments:

• parameters?: object
  • log?: (...args) => void — Logs debug info.

TestTimer provides additional methods:

• async next(): TimerId? — If there're any scheduled functions, skips the time to trigger the next closest one, and returns the triggered timer ID. If there're no scheduled functions, returns undefined.

• async fastForward(timeAmount: number): TimerId[] — Sequentially skips the time to trigger every scheduled function within the specified timeframe. Returns a list of the triggered timer IDs. If some of the functions being triggered schedule new functions, those new function will get triggered as well if they're within the timeframe.

• async fastForwardToLast(): TimerId[] — Sequentially skips the time to trigger every scheduled function until there're no scheduled functions left. Returns a list of the triggered timer IDs. If some of the functions being triggered schedule new functions, those new function will get triggered as well.

import { TestTimer } from 'web-browser-timer'

const timer = new TestTimer()

let triggered = false
const timerId = timer.schedule(async () => triggered = true, 100)

await timer.next() === timerId
triggered === true

await timer.next() === undefined

TestTimer and Promises

The thing about TestTimer is that it doesn't really work with Promises: when a Promise is resolved or rejected, it is scheduled to "return" at the end of an "event loop" iteration. But TestTimer itself doesn't really care or know about the "event loop" so it doesn't "see" any ready-to-return Promises when calling functions like .skipForward(timeAmount) on it. The result is Promises not being resolved or rejected as if those were "stuck". There seems to be no solution for the issue.

Possible workarounds:

• Use callbacks instead of Promises in the code that it covered by tests that use TestTimer.
• Call timer.skipForward() repeatedly with smaller time increments. The .skipForward() function is an async one meaning that an await timer.skipForward() call itself does trigger ending of a current "event loop" iteration which will "unstuck" any ready-to-return Promises when that call get executed.

Test

npm test

GitHub Ban

On March 9th, 2020, GitHub, Inc. silently banned my account (erasing all my repos, issues and comments) without any notice or explanation. Because of that, all source codes had to be promptly moved to GitLab. The GitHub repo is now only used as a backup (you can star the repo there too), and the primary repo is now the GitLab one. Issues can be reported in any repo.

License

MIT