doc: add additional explanation to the wildcard section in permissions

Co-authored-by: Rafael Gonzaga <[email protected]> PR-URL: #53664 Reviewed-By: Rafael Gonzaga <[email protected]> Reviewed-By: James M Snell <[email protected]> Reviewed-By: Marco Ippolito <[email protected]>
nodejs · Jul 16, 2024 · fa58d01 · fa58d01
1 parent 262f2cb
commit fa58d01
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/doc/api/permissions.md b/doc/api/permissions.md
@@ -563,6 +563,14 @@ Wildcards are supported too:
 After passing a wildcard character (`*`) all subsequent characters will
 be ignored. For example: `/home/*.js` will work similar to `/home/*`.
 
+When the permission model is initialized, it will automatically add a wildcard
+(\*) if the specified directory exists. For example, if `/home/test/files`
+exists, it will be treated as `/home/test/files/*`. However, if the directory
+does not exist, the wildcard will not be added, and access will be limited to
+`/home/test/files`. If you want to allow access to a folder that does not exist
+yet, make sure to explicitly include the wildcard:
+`/my-path/folder-do-not-exist/*`.
+
 #### Permission Model constraints
 
 There are constraints you need to know before using this system: