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 note for features using InternalWorker with permission model #56706

Merged
merged 1 commit into from
Jan 23, 2025
Merged

doc: add note for features using InternalWorker with permission model #56706

Show file tree
Hide file tree
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
17 changes: 17 additions & 0 deletions doc/api/cli.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -943,6 +943,13 @@
<!-- YAML
added: v8.8.0
changes:
- version:
- v23.6.1
- v22.13.1
- v20.18.2
pr-url: https://github.com/nodejs-private/node-private/pull/629

Check warning on line 950 in doc/api/cli.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
description: Using this feature with the permission model enabled requires
passing `--allow-worker`.
- version: v12.11.1
pr-url: https://github.com/nodejs/node/pull/29752
description: This flag was renamed from `--loader` to
Expand All @@ -956,6 +963,8 @@
Specify the `module` containing exported [module customization hooks][].
`module` may be any string accepted as an [`import` specifier][].

This feature requires `--allow-worker` if used with the [Permission Model][].

### `--experimental-network-inspection`

<!-- YAML
Expand Down Expand Up @@ -1055,6 +1064,14 @@
added:
- v22.3.0
- v20.18.0
changes:
- version:
- v23.6.1
- v22.13.1
- v20.18.2
pr-url: https://github.com/nodejs-private/node-private/pull/629

Check warning on line 1072 in doc/api/cli.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
description: Using this feature with the permission model enabled requires
passing `--allow-worker`.
-->

> Stability: 1.0 - Early development
Expand Down
10 changes: 10 additions & 0 deletions doc/api/module.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,6 +177,13 @@
- v20.6.0
- v18.19.0
changes:
- version:
- v23.6.1
- v22.13.1
- v20.18.2
pr-url: https://github.com/nodejs-private/node-private/pull/629

Check warning on line 184 in doc/api/module.md

View workflow job for this annotation

GitHub Actions / lint-pr-url 

pr-url doesn't match the URL of the current PR.
description: Using this feature with the permission model enabled requires
passing `--allow-worker`.
- version:
- v20.8.0
- v18.19.0
Expand Down Expand Up @@ -205,6 +212,8 @@
Register a module that exports [hooks][] that customize Node.js module
resolution and loading behavior. See [Customization hooks][].

This feature requires `--allow-worker` if used with the [Permission Model][].

### `module.registerHooks(options)`

<!-- YAML
Expand Down Expand Up @@ -1705,6 +1714,7 @@
[Conditional exports]: packages.md#conditional-exports
[Customization hooks]: #customization-hooks
[ES Modules]: esm.md
[Permission Model]: permissions.md#permission-model
[Source map v3 format]: https://sourcemaps.info/spec.html#h.mofvlxcwqzej
[V8 JavaScript code coverage]: https://v8project.blogspot.com/2017/12/javascript-code-coverage.html
[V8 code cache]: https://v8.dev/blog/code-caching-for-devs
Expand Down
Loading