the top-level API for
istanbul. provides access to the key libraries in
istanbul so you can write your own tools using
istanbul as a library.
var istanbul = require('istanbul');
- matcherFor static
asynchronously returns a function that can match filesystem paths.
The function returned in the callback may be passed directly as a
to the functions in the
When no options are passed, the match function is one that matches all JS
files under the current working directory except ones under
Match patterns are
ant-style patterns processed using the
Examples not provided due to limitations in putting asterisks inside
jsdoc comments. Please refer to tests under
Optional. Lookup options.
the root of the filesystem tree under which to match files. Defaults to
an array of include patterns to match. Defaults to all JS files under the root.
and array of exclude patterns. File paths matching these patterns will be excluded by the returned matcher. Defaults to files under
node_modulesfound anywhere under root.
The callback that is called with two arguments. The first is an
Errorobject in case of errors or a falsy value if there were no errors. The second is a function that may be use as a matcher.
the Collector class
the config module
the abstract ContentWriter class
the concrete FileWriter class
the hook module
the Instrumenter class.
the Report class
the Reporter class
the Store class.
utility for processing coverage objects
the version of the library
the abstract Writer class