timer-shim

library0.3.0jsnpmunverified

Timer-shim is a lightweight wrapper around setTimeout, setInterval, and clearTimeout/clearInterval that facilitates testing time-dependent code without modifying global state. It provides multiple aliases (e.g., timer.timeout, timer.to, timer.t) for convenience and validates arguments against NaN and non-function values. Version 0.3.0 is stable but appears unmaintained (last release 2012). Unlike sinon's fake timers, timer-shim only stubs calls without advancing time. Its key differentiator is simplicity and avoidance of global overrides, making it suitable for isolated unit tests.

testing

npm install timer-shim

github ↗package ↗

INSTALL

IMPORT

SIG · TIMER-SHIM

timer-shim

testingjavascriptv0.3.0

Install

—

Import

—

Disk

—

Pass rate

0/ 6

Env Coverage0 / 6

glibc

18–22

musl

18–22

Install & Compatibility

Where this runs

tested against v? · npm install

Install × environment matrix

Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux

musl

node 18–226 runs

build_error

glibc

node 18–226 runs

build_error

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

default export

✓ const timer = require('timer-shim')

✗ import timer from 'timer-shim'

Package uses CommonJS; no ES module export.

timer.timeout

✓ timer.timeout(100, fn)

✗ timer.timeout(fn, 100)

Both argument orders work, but the standard is (delay, fn).

timer.clear

✓ timer.clear(handle)

✗ clearTimeout(handle)

Use timer.clear instead of global clearTimeout for consistency.

Demonstrates basic usage of timer.interval and timer.timeout, then shows how to stub timer.timeout with sinon for testing.

Debug

Known issues

deprecatedPackage is unmaintained since 2012. No updates for over a decade.

fix

Consider using sinon.useFakeTimers or lolex for modern timer testing.

affects: all

gotchaBoth argument orders (timeout, fn) and (fn, timeout) are supported. May confuse developers expecting strict order.

fix

Be consistent: use (delay, function) to avoid ambiguity.

affects: all

gotchaPackage does not provide a TypeScript declaration file. No compile-time type checking.

fix

Create a custom .d.ts file or use @ts-ignore.

affects: all

gotchatimer.clear is aliased to clearTimeout; it does not handle interval handles separately. Both timeouts and intervals are cleared with the same function.

fix

Use timer.clear for both, but note that it internally calls clearTimeout. Works for both since handles are just numbers.

affects: all

Errors

Common errors & fixes

TypeError: timer.timeout is not a function

Importing the package incorrectly (e.g., using ES6 import in a CommonJS project) or the package was not installed.

fix

Ensure the package is installed and use require('timer-shim'). For ES6, use const timer = require('timer-shim');

timer.clear is not a function

Attempting to call timer.clear before the module is fully loaded or using a different variable name.

fix

Verify the require statement: const timer = require('timer-shim'); then call timer.clear(handle);

ReferenceError: timer is not defined

The timer variable was not declared or scoped incorrectly.

fix

Add: const timer = require('timer-shim'); at the top of the file.

Upgrade

Version history

0.3.0latest on npm

Audit

Dependencies

No dependency data recorded yet.

Agent activity

10 hits · last 30 days

node

Resources

githubhttps://github.com/chakrit/timer-shim ↗

packagehttps://www.npmjs.com/package/timer-shim ↗