From 1a96b498980559dc71c76722238f683a673889d9 Mon Sep 17 00:00:00 2001 From: Deokjin Kim Date: Sat, 25 May 2024 23:11:07 +0900 Subject: [PATCH] doc: fix wrong variable name in example of `timers.tick()` Change variable name from `twoSeconds` to `threeSeconds` because actual value is 3000(ms). And add missing supported timer value(clearImmediate). Plus, fix typo(implicity -> implicitly). --- doc/api/test.md | 24 ++++++++++++------------ 1 file changed, 12 insertions(+), 12 deletions(-) diff --git a/doc/api/test.md b/doc/api/test.md index 3c68924ac4e78c..e9b6039a3deef0 100644 --- a/doc/api/test.md +++ b/doc/api/test.md @@ -2234,10 +2234,10 @@ test('mocks setTimeout to be executed synchronously without having to actually w const nineSecs = 9000; setTimeout(fn, nineSecs); - const twoSeconds = 3000; - context.mock.timers.tick(twoSeconds); - context.mock.timers.tick(twoSeconds); - context.mock.timers.tick(twoSeconds); + const threeSeconds = 3000; + context.mock.timers.tick(threeSeconds); + context.mock.timers.tick(threeSeconds); + context.mock.timers.tick(threeSeconds); assert.strictEqual(fn.mock.callCount(), 1); }); @@ -2253,10 +2253,10 @@ test('mocks setTimeout to be executed synchronously without having to actually w const nineSecs = 9000; setTimeout(fn, nineSecs); - const twoSeconds = 3000; - context.mock.timers.tick(twoSeconds); - context.mock.timers.tick(twoSeconds); - context.mock.timers.tick(twoSeconds); + const threeSeconds = 3000; + context.mock.timers.tick(threeSeconds); + context.mock.timers.tick(threeSeconds); + context.mock.timers.tick(threeSeconds); assert.strictEqual(fn.mock.callCount(), 1); }); @@ -2306,8 +2306,8 @@ test('mocks setTimeout to be executed synchronously without having to actually w #### Using clear functions -As mentioned, all clear functions from timers (`clearTimeout` and `clearInterval`) -are implicity mocked. Take a look at this example using `setTimeout`: +As mentioned, all clear functions from timers (`clearTimeout`, `clearInterval`,and +`clearImmediate`) are implicitly mocked. Take a look at this example using `setTimeout`: ```mjs import assert from 'node:assert'; @@ -2320,7 +2320,7 @@ test('mocks setTimeout to be executed synchronously without having to actually w context.mock.timers.enable({ apis: ['setTimeout'] }); const id = setTimeout(fn, 9999); - // Implicity mocked as well + // Implicitly mocked as well clearTimeout(id); context.mock.timers.tick(9999); @@ -2340,7 +2340,7 @@ test('mocks setTimeout to be executed synchronously without having to actually w context.mock.timers.enable({ apis: ['setTimeout'] }); const id = setTimeout(fn, 9999); - // Implicity mocked as well + // Implicitly mocked as well clearTimeout(id); context.mock.timers.tick(9999);