Skip to content

doc: document vm timeout option perf impact #12751

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

Closed
wants to merge 1 commit into from
Closed

doc: document vm timeout option perf impact #12751

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
4 changes: 4 additions & 0 deletions doc/api/vm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,10 @@ console.log(util.inspect(sandbox));
// { animal: 'cat', count: 12, name: 'kitty' }
```

*Note*: Using the `timeout` or `breakOnSigint` options will result in new
event loops and corresponding threads being started, which have a non-zero
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does using breakOnSigint option start a new event loop though? Either I am wrong or the language is somewhat confusing here.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, breakOnSigint doesn’t start its own loop, only an extra thread. It’s definitely just an implementation detail, but if you have suggestions for better wording, I’ll take them. :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd say something like "Using the timeout option will result in creating a new event loop and utilizing the breakOnSigint option will cause a helper thread to be started", but, well, I agree that it is an implementation detail and your version is more concise, so I'm fine with it either way.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@aqrln The timeout option will create both a thread and a new event loop. ;) (I would actually assume spinning up the thread is much more costly – basically, what I’m trying to say is that both will allocate and consume new resources.)

Copy link
Contributor

@refack refack Apr 29, 2017 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe remove non-zero

performance overhead.

### script.runInNewContext([sandbox][, options])
<!-- YAML
added: v0.3.1
Expand Down