dependabit / test-utils/src / createMockTimer

Function: createMockTimer()

function createMockTimer(): {
  advanceTimersByTime: (ms) => VitestUtils;
  restore: () => VitestUtils;
  runAll: () => VitestUtils;
  runOnlyPendingTimers: () => VitestUtils;
};

Defined in: packages/test-utils/src/mocks.ts:51

Activates Vitest fake timers and returns a helper object.

Returns

{
  advanceTimersByTime: (ms) => VitestUtils;
  restore: () => VitestUtils;
  runAll: () => VitestUtils;
  runOnlyPendingTimers: () => VitestUtils;
}

Name	Type	Defined in
advanceTimersByTime()	(ms) => VitestUtils	packages/test-utils/src/mocks.ts:56
restore()	() => VitestUtils	packages/test-utils/src/mocks.ts:57
runAll()	() => VitestUtils	packages/test-utils/src/mocks.ts:54
runOnlyPendingTimers()	() => VitestUtils	packages/test-utils/src/mocks.ts:55

Remarks

Call restore() in an afterEach hook to reset real timers.

Example

const timer = createMockTimer();
timer.runAll();