aboutsummaryrefslogtreecommitdiff
path: root/node_modules/collect-v8-coverage/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/collect-v8-coverage/README.md')
-rw-r--r--node_modules/collect-v8-coverage/README.md15
1 files changed, 15 insertions, 0 deletions
diff --git a/node_modules/collect-v8-coverage/README.md b/node_modules/collect-v8-coverage/README.md
new file mode 100644
index 0000000..c5240d6
--- /dev/null
+++ b/node_modules/collect-v8-coverage/README.md
@@ -0,0 +1,15 @@
+# collect-v8-coverage
+
+Use this module to start and stop the V8 inspector manually and collect precise coverage.
+
+```js
+const {CoverageInstrumenter} = require('collect-v8-coverage');
+
+const instrumenter = new CoverageInstrumenter();
+
+await instrumenter.startInstrumenting();
+
+// require some modules, run some code
+
+const coverage = await instrumenter.stopInstrumenting();
+```