README.md

covjson-reader

A library that reads CoverageJSON documents and exposes them as Coverage data objects.

API docs

Usage

A browser version of this library is hosted on both jsDelivr and cdnjs.

Usage is simple:

<script src="https://cdn.jsdelivr.net/npm/[email protected]/covutils-lite.min.js"></script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/covjson-reader.min.js"></script>
<script>
CovJSON.read('http://example.com/coverage.covjson').then(function (cov) {
  // work with Coverage object
}).catch(function (e) {
  // there was an error when loading the coverage
  console.log(e)
})
</script>

Note that this package has a dependency on the covutils package which must be loaded separately when using the browser bundle as shown above.

NPM

This library can be used with browserify and similar tools by importing it via npm.

ES2015 syntax:

import * as CovJSON from 'covjson-reader'

CovJSON.read('http://example.com/coverage.covjson').then(cov => {
  // work with Coverage object
}).catch(e => {
  // there was an error when loading the coverage
  console.log(e)
})

Acknowledgments

This library has been developed within the MELODIES project and is maintained as open source software.