code/wrench-js
Archived
1
Fork 0
Code Issues 22 Pull requests 7 Projects Releases Packages Wiki Activity Actions

Updated readme based on filter improvements

Browse source
This commit is contained in:
Patrick Steele-Idem 2013-07-24 23:45:49 -06:00
parent 5acb4ed037
commit c9c99d43b6
1 changed files with 7 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

8
readme.md
View file

@ -66,10 +66,16 @@ wrench.copyDirSyncRecursive('directory_to_copy', 'location_where_copy_should_end
excludeHiddenUnix: bool, // Whether to copy hidden Unix files or not (preceding .) excludeHiddenUnix: bool, // Whether to copy hidden Unix files or not (preceding .)
preserveFiles: bool, // If we're overwriting something and the file already exists, keep the existing preserveFiles: bool, // If we're overwriting something and the file already exists, keep the existing
inflateSymlinks: bool, // Whether to follow symlinks or not when copying files inflateSymlinks: bool, // Whether to follow symlinks or not when copying files
filter: regexp, // A filter to match files against; if matches, do nothing (exclude). filter: regexpOrFunction, // A filter to match files against; if matches, do nothing (exclude).
whitelist: bool, // if true every file or directory which doesn't match filter will be ignored whitelist: bool, // if true every file or directory which doesn't match filter will be ignored
include: regexpOrFunction, // An include filter (either a regexp or a function)
exclude: regexpOrFunction // An include filter (either a regexp or a function)
}); });
*NOTE:* If a RegExp is provided then then it will be matched against the filename. If a function is
provided then the signature should be the following:
`function(filename, dir) { return result; }`
// Read lines in from a file until you hit the end // Read lines in from a file until you hit the end
var f = new wrench.LineReader('x.txt'); var f = new wrench.LineReader('x.txt');
while(f.hasNextLine()) { while(f.hasNextLine()) {