doc: add note for features using InternalWorker with permission model

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

Hide file tree

Showing 2 changed files with 18 additions and 0 deletions.
diff --git a/doc/api/cli.md b/doc/api/cli.md
@@ -951,6 +951,10 @@ Previously gated the entire `import.meta.resolve` feature.
 <!-- YAML
 added: v8.8.0
 changes:
+  - version: 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
@@ -964,6 +968,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-imports`
 
 <!-- YAML
@@ -1070,6 +1076,11 @@ report is not generated. See the documentation on
 
 <!-- YAML
 added: v20.18.0
+changes:
+  - version: 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
@@ -87,6 +87,10 @@ isBuiltin('wss'); // false
 <!-- YAML
 added: v20.6.0
 changes:
+  - version: 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
     pr-url: https://github.com/nodejs/node/pull/49655
     description: Add support for WHATWG URL instances.
@@ -113,6 +117,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.syncBuiltinESMExports()`
 
 <!-- YAML
@@ -1117,6 +1123,7 @@ returned object contains the following keys:
 [Customization hooks]: #customization-hooks
 [ES Modules]: esm.md
 [HTTPS and HTTP imports]: esm.md#https-and-http-imports
+[Permission Model]: permissions.md#permission-model
 [Source map v3 format]: https://sourcemaps.info/spec.html#h.mofvlxcwqzej
 [`"exports"`]: packages.md#exports
 [`--enable-source-maps`]: cli.md#--enable-source-maps