From cad08ee19b0cabe96a23b038a21723f64437d0e4 Mon Sep 17 00:00:00 2001 From: Hong Xu Date: Fri, 16 Feb 2024 00:45:20 -0800 Subject: [PATCH] docs: add config param to `useFakeTimer` (#5213) --- docs/api/vi.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/api/vi.md b/docs/api/vi.md index 7d0ab77ac6ce..087871bd5a01 100644 --- a/docs/api/vi.md +++ b/docs/api/vi.md @@ -736,7 +736,7 @@ vi.useRealTimers() ### vi.useFakeTimers -- **Type:** `() => Vitest` +- **Type:** `(config?: FakeTimerInstallOpts) => Vitest` To enable mocking timers, you need to call this method. It will wrap all further calls to timers (such as `setTimeout`, `setInterval`, `clearTimeout`, `clearInterval`, `nextTick`, `setImmediate`, `clearImmediate`, and `Date`), until [`vi.useRealTimers()`](#vi-userealtimers) is called.