stats-filelist - npm Package Compare versions

Comparing version 0.1.0 to 0.1.1

lib/stats-filelist.js

@@ -10,2 +10,3 @@ /*
 'use strict';
+
 var
@@ -12,0 +13,0 @@ DEFAULT_OPTIONS = {

package.json

 {
   "name": "stats-filelist",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "title": "statsFilelist",
@@ -5,0 +5,0 @@ "description": "Get the list of files and directories with its `Stats`. And filter the list with evaluating path, path pattern, type, size, modified time, and more.",

README.md

@@ -7,4 +7,7 @@ # statsFilelist
 That expanded `fs.Stats` object has additional properties such as `fullPath`, `extension`, etc.. (See [`Stats` object](#stats-object).)  
-It returns the filtered list if you want. That filter evaluates that `Stats` object by using flexible ways such as RegExp, callback, etc..
+The got `Stats` objects will be useful more than the path list because you are supposed to do something with those files or directories after getting those.
 
+It returns the filtered list if you want. That filter evaluates that `Stats` object by using flexible ways such as RegExp, callback, etc..  
+And also, the filter can control the behavior of statsFilelist. For example, it make statsFilelist stop getting files any more when the file you want was found out.
+
 ```js
@@ -30,15 +33,15 @@ var filelist = require('stats-filelist');
 ```js
-filelist.get(path, callback, options)
+filelist.get(path, callback[, options])
 ```
 
 ```js
-filelist.get(path, callback, filter, recursive)
+filelist.get(path, callback[, filter[, recursive]])
 ```
 
 ```js
-list = filelist.getSync(path, options)
+list = filelist.getSync(path[, options])
 ```
 
 ```js
-list = filelist.getSync(path, filter, recursive)
+list = filelist.getSync(path[, filter[, recursive]])
 ```
@@ -45,0 +48,0 @@

No alert changes

Improved metrics

Total package byte prevSize

20501

1.68%

Number of lines in readme file

344

0.88%

No dependency changes