doc: add performance note to --enable-source-maps docs

PR-URL: #43817 Reviewed-By: Ben Coe <[email protected]> Reviewed-By: Chengzhong Wu <[email protected]>
nodejs · Aug 15, 2022 · 51b4a1b · 51b4a1b
1 parent 63b5c49
commit 51b4a1b
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/doc/api/cli.md b/doc/api/cli.md
@@ -336,6 +336,11 @@ effort to report stack traces relative to the original source file.
 Overriding `Error.prepareStackTrace` prevents `--enable-source-maps` from
 modifying the stack trace.
 
+Note, enabling source maps can introduce latency to your application
+when `Error.stack` is accessed. If you access `Error.stack` frequently
+in your application, take into account the performance implications
+of `--enable-source-maps`.
+
 ### `--experimental-global-customevent`
 
 <!-- YAML