aboutsummaryrefslogtreecommitdiff
path: root/node_modules/istanbul-lib-coverage/README.md
diff options
context:
space:
mode:
authorJoel Kronqvist <work.joelkronqvist@pm.me>2022-03-11 20:46:06 +0200
committerJoel Kronqvist <work.joelkronqvist@pm.me>2022-03-11 20:46:06 +0200
commit080c5819d87b933816d724a83f3bf4f1686770a7 (patch)
tree4a2ccc68b27edf7d4cbc586c932cc7542b655e19 /node_modules/istanbul-lib-coverage/README.md
parent5ac7049a9d30733165cc212dee308163c2a14644 (diff)
parentd003b82235a9329f912522a2f70aa950dfce4998 (diff)
downloadLYLLRuoka-080c5819d87b933816d724a83f3bf4f1686770a7.tar.gz
LYLLRuoka-080c5819d87b933816d724a83f3bf4f1686770a7.zip
Merge branch 'master' of https://github.com/JoelHMikael/FoodJS
Updating remote changes
Diffstat (limited to 'node_modules/istanbul-lib-coverage/README.md')
-rw-r--r--node_modules/istanbul-lib-coverage/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/node_modules/istanbul-lib-coverage/README.md b/node_modules/istanbul-lib-coverage/README.md
new file mode 100644
index 0000000..2c24a56
--- /dev/null
+++ b/node_modules/istanbul-lib-coverage/README.md
@@ -0,0 +1,29 @@
+## istanbul-lib-coverage
+
+[![Greenkeeper badge](https://badges.greenkeeper.io/istanbuljs/istanbul-lib-coverage.svg)](https://greenkeeper.io/)
+[![Build Status](https://travis-ci.org/istanbuljs/istanbul-lib-coverage.svg?branch=master)](https://travis-ci.org/istanbuljs/istanbul-lib-coverage)
+
+An API that provides a read-only view of coverage information with the ability
+to merge and summarize coverage info.
+
+Supersedes `object-utils` and `collector` from the v0 istanbul API.
+
+See the docs for the full API.
+
+```js
+var libCoverage = require('istanbul-lib-coverage');
+var map = libCoverage.createCoverageMap(globalCoverageVar);
+var summary = libCoverage.createCoverageSummary();
+
+// merge another coverage map into the one we created
+map.merge(otherCoverageMap);
+
+// inspect and summarize all file coverage objects in the map
+map.files().forEach(function(f) {
+ var fc = map.fileCoverageFor(f),
+ s = fc.toSummary();
+ summary.merge(s);
+});
+
+console.log('Global summary', summary);
+```