doc: explain how to invoke gc

Currently the documentation for Wrapping C++ Objects doesn't explain how to destruct an object by explicitly invoking the garbage collector. This commit includes a modification to docs that explains how to force the garbage collector to clear objects using V8's command line flags. Fixes: #19876 PR-URL: #20431 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Yang Guo <[email protected]>
nodejs · Sep 20, 2018 · 6ed5845 · 6ed5845
1 parent 6367349
commit 6ed5845
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/doc/api/addons.md b/doc/api/addons.md
@@ -848,6 +848,13 @@ console.log(obj.plusOne());
 // Prints: 13
 ```
 
+The destructor for a wrapper object will run when the object is
+garbage-collected. For destructor testing, there are command-line flags that
+can be used to make it possible to force garbage collection. These flags are
+provided by the underlying V8 JavaScript engine. They are subject to change
+or removal at any time. They are not documented by Node.js or V8, and they
+should never be used outside of testing.
+
 ### Factory of wrapped objects
 
 Alternatively, it is possible to use a factory pattern to avoid explicitly