Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: add missing parameter types #39013

Closed
wants to merge 2 commits into from
Closed

doc: add missing parameter types #39013

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
b375675
doc: add missing parameter types
VoltrexKeyva Jun 12, 2021
73032bc
fixup! doc: add missing parameter types
VoltrexKeyva Jun 12, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions doc/api/timers.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -307,7 +307,8 @@ Cancels an `Immediate` object created by [`setImmediate()`][].
added: v0.0.1
-->

* `timeout` {Timeout} A `Timeout` object as returned by [`setInterval()`][].
* `timeout` {Timeout|string|number} A `Timeout` object as returned by [`setInterval()`][]
or the [primitive][] of the `Timeout` object as a string or a number.

Cancels a `Timeout` object created by [`setInterval()`][].

Expand All @@ -316,7 +317,8 @@ Cancels a `Timeout` object created by [`setInterval()`][].
added: v0.0.1
-->

* `timeout` {Timeout} A `Timeout` object as returned by [`setTimeout()`][].
* `timeout` {Timeout|string|number} A `Timeout` object as returned by [`setTimeout()`][]
or the [primitive][] of the `Timeout` object as a string or a number.

Cancels a `Timeout` object created by [`setTimeout()`][].

Expand Down Expand Up @@ -478,3 +480,4 @@ const interval = 100;
[`setTimeout()`]: timers.md#timers_settimeout_callback_delay_args
[`util.promisify()`]: util.md#util_util_promisify_original
[`worker_threads`]: worker_threads.md
[primitive]: timers.md#timers_timeout_symbol_toprimitive