Skip to content

Commit 2246562

Browse files
ianstarzjdonaghue
authored andcommitted
update readme for new exclude functionality (#101)
1 parent 57a8e15 commit 2246562

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -147,7 +147,7 @@ The argument of `options` can contain the following properties:
147147
|Property|Type|Default|Description|
148148
|--------|----|-------|-----------|
149149
|basePath|String|Path found in source map|A string to use as the base path for the source locations|
150-
|exclude|String/RegEx|`undefined`|If the filename of the source coverage file matches, it will be skipped while mapping the coverage|
150+
|exclude|String/RegEx/Function|`undefined`|If the filename of the source coverage file matches the String or RegEx, it will be skipped while mapping the coverage. Optionally, you can use a function that accepts the filename as the argument, and returns true if the file should be skipped.|
151151
|readFile|Function|`fs.readFileSync`|A function that will synchronously read a file|
152152
|readJSON|Function|`JSON.parse(fs.readFileSync)`|A function that will synchronously read a file and return a POJO based on the JSON data in the file|
153153
|warn|Function|`console.warn`|A function that logs warning messages|

0 commit comments

Comments
 (0)