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.

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: mention v8.setFlagsFromString to pm #53731

Merged
merged 1 commit into from
Jul 6, 2024
Merged
Changes from all commits
Commits
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
3 changes: 2 additions & 1 deletion doc/api/permissions.md
Original file line number Diff line number Diff line change
Expand Up @@ -586,7 +586,8 @@ There are constraints you need to know before using this system:
* The Permission Model is initialized after the Node.js environment is set up.
However, certain flags such as `--env-file` or `--openssl-config` are designed
to read files before environment initialization. As a result, such flags are
not subject to the rules of the Permission Model.
not subject to the rules of the Permission Model. The same applies for V8
flags that can be set via runtime through `v8.setFlagsFromString`.
Copy link
Member

@RedYetiDev RedYetiDev Jul 4, 2024

Choose a reason for hiding this comment

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

Suggested change
flags that can be set via runtime through `v8.setFlagsFromString`.
flags that can be set via runtime through methods such as `v8.setFlagsFromString()`.

IMO using 'such as' allows accounts for any future functions with this behavior that might happen without updating this document.

(nit: functions are described via () IIRC)

* OpenSSL engines cannot be requested at runtime when the Permission
Model is enabled, affecting the built-in crypto, https, and tls modules.
* Using existing file descriptors via the `node:fs` module bypasses the
Expand Down
Loading