@nvnh/clock
is a small library without dependencies for mocking time in Javascript. It's inspired by this clock package for Go.
The goal is to resemble Javascript's Date & Time interface as closely as possible, so you can easily replace it in your existing code:
Date.now()
becomesclock.now()
new Date()
becomesclock.newDate()
- etc...
Here's the complete interface:
export interface Clock {
now(): number;
newDate(): Date;
newDate(value: number | string | Date): Date;
setTimeout(handler: TimerHandler, timeout?: number, ...args: any[]): number;
clearTimeout(id: number | undefined): void;
setInterval(handler: TimerHandler, timeout?: number, ...args: any[]): number;
clearInterval(id: number | undefined): void;
}
@nvnh/clock
gives you complete control over time:
- Use
Clock
in your application for default behavior. - Use
MockClock
in tests to have complete control over time. - Replace
Clock
byWarpClock
in your application to see how it behaves at a different point in time. You can time travel and speed up or slow down time. Useful for debugging time-related problems, eg. using your application around midnight, year changes, leap years or use ofsetTimeout()
that would let you wait a long time.
npm install @nvnh/clock
// Import default clock instance
import clock from "@nvnh/clock";
// use it just like Javascript's Date
console.log(clock.newDate().toISOString()); // eg. 2025-07-12T15:15:21.376Z
// will have the same output as
console.log(new Date().toISOString()); // eg. 2025-07-12T15:15:21.376Z
import { createMockClock } from "@nvnh/clock/mock";
// Create a mock clock instance
const mockClock = createMockClock("2030-11-24T08:30:25Z");
// newDate() returns the initial date
console.log(mockClock.newDate().toISOString()) // 2030-11-24T08:30:25.000Z
// move time ahead by 2 seconds
mockClock.add(2000);
// newDate() returns the updated date & time
console.log(mockClock.newDate().toISOString()) // 2030-11-24T08:30:27.000Z
// move time ahead to the specified time
mockClock.goTo("2030-11-25T07:30:00Z");
// newDate() returns the new date & time
console.log(mockClock.newDate().toISOString()) // 2030-11-25T07:30:00.000Z
Export a single clock instance to use in your whole application (eg. clock.js
):
import clock from "@nvnh/clock";
export default clock;
When you need different time behavior in your application (eg. to debug a time-related bug), replace the real clock with a WarpClock
:
// import clock from "@nvnh/clock";
import { createWarpClock } from "@nvnh/clock";
// export default clock;
export default createWarpClock({
initial: "2024-12-31T23:59:30Z",
speed: 4.0,
});
The last week example implements a function with signature:
lastWeek(): { from: Date, to: Date }
Where:
from
is a Javascript date representing monday 00:00:00 of the previous week.to
is a Javascript date representing sunday 23:59:59 of the previous week.
The code is documented and shows how you can use @nvnh/clock
in your own code.
The only code that needs to change is code that determines what time it is:
- In Luxon,
DateTime.now()
becomesnew DateTime(clock.now())
- In Moment.js,
moment()
becomesmoment(clock.now())
- date-fns doesn't determine the current time, so you only need to replace where Vanilla JS determines what time it is:
Date.now()
becomesclock.now()
,new Date()
becomesclock.newDate()
.
The best way is to have a single Clock
instance injected into your components by a dependency injection system.
In React you can use Context.
Vue.js has Provide / Inject.
Angular has dependency injection.
It should work with any dependency injection system you have in your project.