Istanbul Class
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.
Usage
var istanbul = require('istanbul');Item Index
Methods
- matcherFor static
Properties
- Collector static
- config static
- ContentWriter static
- FileWriter static
- hook static
- Instrumenter static
- Report static
- Reporter static
- Store static
- utils static
- VERSION static
- Writer static
Methods
matcherFor
-
options -
callback
asynchronously returns a function that can match filesystem paths.
The function returned in the callback may be passed directly as a matcher
to the functions in the hook module.
When no options are passed, the match function is one that matches all JS
files under the current working directory except ones under node_modules
Match patterns are ant-style patterns processed using the fileset library.
Examples not provided due to limitations in putting asterisks inside
jsdoc comments. Please refer to tests under test/other/test-matcher.js
for examples.
Parameters:
-
optionsObjectOptional. Lookup options.
-
[root]String optionalthe root of the filesystem tree under which to match files. Defaults to
process.cwd() -
[includes]Array optionalan array of include patterns to match. Defaults to all JS files under the root.
-
[excludes]Array optionaland 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.
-
-
callbackFunction(err, matchFunction)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.
Properties
VERSION
String
static
the version of the library