diff options
Diffstat (limited to 'node_modules/istanbul-lib-coverage/README.md')
| -rw-r--r-- | node_modules/istanbul-lib-coverage/README.md | 32 |
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 +--------------------- + +[](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); + +``` + |