OSSForks/node
1
0
Fork 0
mirror of https://github.com/zebrajr/node.git synced 2026-01-15 12:15:26 +00:00
Code Issues Actions 8 Packages Projects Releases Wiki Activity

doc: add timeout.close

Browse Source 
PR-URL: https://github.com/nodejs/node/pull/40036
Reviewed-By: Antoine du Hamel <duhamelantoine1995@gmail.com>
Reviewed-By: Tobias Nießen <tniessen@tnie.de>
Reviewed-By: Michaël Zasso <targos@protonmail.com>
This commit is contained in:
Nikita Galkin
2021-09-08 13:00:04 +03:00
committed by Node.js GitHub Bot
parent c3651453c9
commit de10ab25d3
1 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
doc/api/timers.md
View File

@@ -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