index.js 986 B

12345678910111213141516171819202122232425262728293031323334353637383940
  1. /*
  2. Copyright 2012-2015, Yahoo Inc.
  3. Copyrights licensed under the New BSD License. See the accompanying LICENSE file for terms.
  4. */
  5. 'use strict';
  6. /**
  7. * @module Exports
  8. */
  9. const Context = require('./lib/context');
  10. const watermarks = require('./lib/watermarks');
  11. const ReportBase = require('./lib/report-base');
  12. module.exports = {
  13. /**
  14. * returns a reporting context for the supplied options
  15. * @param {Object} [opts=null] opts
  16. * @returns {Context}
  17. */
  18. createContext(opts) {
  19. return new Context(opts);
  20. },
  21. /**
  22. * returns the default watermarks that would be used when not
  23. * overridden
  24. * @returns {Object} an object with `statements`, `functions`, `branches`,
  25. * and `line` keys. Each value is a 2 element array that has the low and
  26. * high watermark as percentages.
  27. */
  28. getDefaultWatermarks() {
  29. return watermarks.getDefault();
  30. },
  31. /**
  32. * Base class for all reports
  33. */
  34. ReportBase
  35. };