aboutsummaryrefslogtreecommitdiff
path: root/node_modules/istanbul-lib-coverage/README.md
diff options
context:
space:
mode:
authorFlorian Dold <florian.dold@gmail.com>2016-10-10 03:43:44 +0200
committerFlorian Dold <florian.dold@gmail.com>2016-10-10 03:43:44 +0200
commitabd94a7f5a50f43c797a11b53549ae48fff667c3 (patch)
treeab8ed457f65cdd72e13e0571d2975729428f1551 /node_modules/istanbul-lib-coverage/README.md
parenta0247c6a3fd6a09a41a7e35a3441324c4dcb58be (diff)
downloadwallet-core-abd94a7f5a50f43c797a11b53549ae48fff667c3.tar.xz
add node_modules to address #4364
Diffstat (limited to 'node_modules/istanbul-lib-coverage/README.md')
-rw-r--r--node_modules/istanbul-lib-coverage/README.md32
1 files changed, 32 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 000000000..2f893e297
--- /dev/null
+++ b/node_modules/istanbul-lib-coverage/README.md
@@ -0,0 +1,32 @@
+istanbul-lib-coverage
+---------------------
+
+[![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);
+
+```
+