From 3c104653001d3fd018a99bdea29f6bad15b50556 Mon Sep 17 00:00:00 2001 From: Nikita Galkin Date: Wed, 8 Sep 2021 13:00:04 +0300 Subject: [PATCH] doc: add timeout.close --- doc/api/timers.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/doc/api/timers.md b/doc/api/timers.md index 2efd0864824c0c..9105e93a9a6bb3 100644 --- a/doc/api/timers.md +++ b/doc/api/timers.md @@ -72,6 +72,17 @@ timer is active. Each of the `Timeout` objects returned by these functions export both `timeout.ref()` and `timeout.unref()` functions that can be used to control this default behavior. +### `timeout.close()` + + +> Stability: 3 - Legacy: Use [`clearTimeout()`][] instead. + +* Returns: {Timeout} a reference to `timeout` + +Cancels the timeout. + ### `timeout.hasRef()`