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)

Stub

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

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