doc: add timeout.close

PR-URL: #40036 Reviewed-By: Antoine du Hamel <[email protected]> Reviewed-By: Tobias Nießen <[email protected]> Reviewed-By: Michaël Zasso <[email protected]>
nodejs · Sep 21, 2021 · 7fdb127 · 7fdb127
1 parent effdfa9
commit 7fdb127
Showing 1 changed file with 11 additions and 0 deletions.
diff --git 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()`
+<!-- YAML
+added: v0.9.1
+-->
+
+> Stability: 3 - Legacy: Use [`clearTimeout()`][] instead.
+
+* Returns: {Timeout} a reference to `timeout`
+
+Cancels the timeout.
+
 ### `timeout.hasRef()`
 <!-- YAML
 added: v11.0.0