file-set - npm Package Compare versions

Comparing version 0.2.0 to 0.2.1

lib/file-set.js

@@ -7,4 +7,9 @@ var fs = require("fs"),
 /**
+Exports a contructor taking a list of file patterns as input, returning a `file-set` instance containing the expanded patterns split into separate lists of `files`, `dirs` and `notExisting`.
 @module
-@alias fileSet
+@example
+```js
+var fileSet = require("file-set");
+```
+@alias FileSet
 */
@@ -15,8 +20,4 @@ module.exports = FileSet;
 @class
-The file-set constructor.
+@classdesc Expands file patterns, returning the matched and unmatched files and directories
 @param {string | string[]} - A pattern, or array of patterns to expand
-@example
-```js
-var fileSet = require("file-set");
-```
 @alias module:file-set
@@ -23,0 +24,0 @@ */

package.json

 {
   "name": "file-set",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "Expands file patterns, returning the matched and unmatched files and directories.",
@@ -9,3 +9,3 @@ "main": "lib/file-set.js",
     "test": "tape test/*.js",
-    "docs": "jsdoc2md -t jsdoc2md/README.hbs lib/file-set.js --index > README.md; echo "
+    "docs": "jsdoc2md -t jsdoc2md/README.hbs lib/file-set.js > README.md; echo "
   },
@@ -12,0 +12,0 @@ "author": "Lloyd Brookes",

README.md

@@ -7,4 +7,11 @@ [![view on npm](http://img.shields.io/npm/v/file-set.svg)](https://www.npmjs.org/package/file-set)
 #file-set
-Exports a single contructor taking a list of file patterns as input, returning a `file-set` instance containing the expanded patterns split into separate lists of `files`, `dirs` and `notExisting`.
+Exports a contructor taking a list of file patterns as input, returning a `file-set` instance containing the expanded patterns split into separate lists of `files`, `dirs` and `notExisting`.
 
+**Example**  
+```js
+var fileSet = require("file-set");
+```
+
+
+
 ##Install
@@ -36,20 +43,23 @@ ```sh
 
+#API
 <a name="module_file-set"></a>
-##file-set(patternList)
+##class: FileSet ⏏
+Expands file patterns, returning the matched and unmatched files and directories
 
-- patternList `string | Array.<string>` - A pattern, or array of patterns to expand
+**Members**
 
-  
-####Example
-```js
-var fileSet = require("file-set");
-```
-**Contents**
-* [list](#module_file-set#list)
-* [files](#module_file-set#files)
-* [dirs](#module_file-set#dirs)
-* [notExisting](#module_file-set#notExisting)
-* [eFileType](#module_file-set.eFileType)
-* [add(files)](#module_file-set#add)
+* [new FileSet(patternList)](#module_file-set)
+* [fileSet.list](#module_file-set#list)
+* [fileSet.files](#module_file-set#files)
+* [fileSet.dirs](#module_file-set#dirs)
+* [fileSet.notExisting](#module_file-set#notExisting)
+* [fileSet.add(files)](#module_file-set#add)
+* [enum: FileSet.eFileType](#module_file-set.eFileType)
 
+<a name="module_file-set"></a>
+###new FileSet(patternList)
+**Params**
+
+- patternList `string` | `Array.<string>` - A pattern, or array of patterns to expand
+
 <a name="module_file-set#list"></a>
@@ -79,12 +89,12 @@ ###fileSet.list
 
+**Params**
 
-- files `string | Array.<string>` - A pattern, or array of patterns to expand
+- files `string` | `Array.<string>` - A pattern, or array of patterns to expand
 
 <a name="module_file-set.eFileType"></a>
-###fileSet.eFileType
+###enum: FileSet.eFileType
 Enum for the `type` value of each record in `fileSet.list`
 
-**Enum** with properties: `NOEXIST`, `FILE`, `DIR`  
+**Type**: `number`  
+**Properties**: `NOEXIST`, `FILE`, `DIR`  
 **Read only**: true  
-**Type**: `number`  
-

No alert changes

Improved metrics

Total package byte prevSize

8992

increased by4.57%

Lines of code

139

increased by0.72%

Number of lines in readme file

98

increased by11.36%

No dependency changes