doc: add note for features using InternalWorker with permission model

PR-URL: #56706 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Richard Lau <[email protected]> Reviewed-By: Luigi Pinca <[email protected]>
nodejs · Jan 23, 2025 · a4895e2 · a4895e2
1 parent 309924f
commit a4895e2
Show file tree

Hide file tree

Showing 2 changed files with 27 additions and 0 deletions.
diff --git a/doc/api/cli.md b/doc/api/cli.md
@@ -943,6 +943,13 @@ Previously gated the entire `import.meta.resolve` feature.
 <!-- 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
+    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
@@ -956,6 +963,8 @@ changes:
 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
@@ -1055,6 +1064,14 @@ report is not generated. See the documentation on
 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
+    description: Using this feature with the permission model enabled requires
+                 passing `--allow-worker`.
 -->
 
 > Stability: 1.0 - Early development

diff --git a/doc/api/module.md b/doc/api/module.md
@@ -177,6 +177,13 @@ added:
   - 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
+    description: Using this feature with the permission model enabled requires
+                 passing `--allow-worker`.
   - version:
     - v20.8.0
     - v18.19.0
@@ -205,6 +212,8 @@ changes:
 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
@@ -1705,6 +1714,7 @@ returned object contains the following keys:
 [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