-
Notifications
You must be signed in to change notification settings - Fork 29.6k
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.
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: clarify use of timeout option in vm #23512
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM. Does it already throw in all cases if the value is not a positive integer?
@targos I believe so. I tested 0, 0.1, 10.1 and they all failled |
Maybe it is worth to replace the |
@vsemozhetbyt do you know if we use it somewhere else in the doc? From a js perspective, the argument is of type |
FWIW, we have it as a hint in Line 8 in b2d8ae0
And we use it in docs: https://github.com/nodejs/node/search?l=Markdown&q=%7Binteger%7D |
Make sense! I'll update :) Thanks for pointing it! |
This updates the documentation to clarify how to use `timeout` in the vm module.
I am not sure why CI considers the subsystem is missing 🤔 |
I saw this on other PRs as well. Probably something wrong with our |
Let's restart CI when #23739 (review) is merged then |
Landed in 278086a |
This updates the documentation to clarify how to use `timeout` in the vm module. PR-URL: nodejs#23512 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This updates the documentation to clarify how to use `timeout` in the vm module. PR-URL: #23512 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This updates the documentation to clarify how to use `timeout` in the vm module. PR-URL: #23512 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This updates the documentation to clarify how to use `timeout` in the vm module. PR-URL: #23512 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
This updates the documentation to clarify how to use `timeout` in the vm module. PR-URL: #23512 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Checklist
make -j4 test
(UNIX), orvcbuild test
(Windows) passesThis clarifies the use of the
timeout
option in thevm
module. This number always must be a strictly positive integer otherwise it results in aTypeError