Comparing version 0.2.3 to 0.2.4
{ | ||
"name": "file-set", | ||
"version": "0.2.3", | ||
"version": "0.2.4", | ||
"description": "Expands file patterns, returning the matched and unmatched files and directories.", | ||
@@ -13,3 +13,2 @@ "main": "lib/file-set.js", | ||
"devDependencies": { | ||
"jsdoc-to-markdown": "~0.6", | ||
"tape": "^3.0.3" | ||
@@ -16,0 +15,0 @@ }, |
@@ -6,3 +6,3 @@ [![view on npm](http://img.shields.io/npm/v/file-set.svg)](https://www.npmjs.org/package/file-set) | ||
#file-set | ||
# file-set | ||
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`. | ||
@@ -16,3 +16,3 @@ | ||
##Install | ||
## Install | ||
```sh | ||
@@ -22,3 +22,3 @@ $ npm install file-set --save | ||
##Usage | ||
## Usage | ||
```js | ||
@@ -44,3 +44,3 @@ > var fileSet = require("file-set"); | ||
#API | ||
# API | ||
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`. | ||
@@ -66,50 +66,52 @@ | ||
<a name="exp_module_file-set--FileSet"></a> | ||
###class: FileSet ⏏ | ||
### class: FileSet ⏏ | ||
Expands file patterns, returning the matched and unmatched files and directories | ||
<a name="new_module_file-set--FileSet_new"></a> | ||
####new FileSet(patternList) | ||
#### new FileSet(patternList) | ||
| Param | Type | Description | | ||
| ----- | ---- | ----------- | | ||
| --- | --- | --- | | ||
| patternList | <code>string</code> \| <code>Array.<string></code> | A pattern, or array of patterns to expand | | ||
<a name="module_file-set--FileSet#list"></a> | ||
####fileSet.list → <code>Array.<string></code> | ||
#### fileSet.list → <code>Array.<string></code> | ||
The full list of unique paths found, and not found. | ||
<a name="module_file-set--FileSet#files"></a> | ||
####fileSet.files → <code>Array.<string></code> | ||
#### fileSet.files → <code>Array.<string></code> | ||
The existing files found | ||
<a name="module_file-set--FileSet#dirs"></a> | ||
####fileSet.dirs → <code>Array.<string></code> | ||
#### fileSet.dirs → <code>Array.<string></code> | ||
The existing directories found | ||
<a name="module_file-set--FileSet#notExisting"></a> | ||
####fileSet.notExisting → <code>Array.<string></code> | ||
#### fileSet.notExisting → <code>Array.<string></code> | ||
Paths which were not found | ||
<a name="module_file-set--FileSet#add"></a> | ||
####fileSet.add(files) | ||
#### fileSet.add(files) | ||
add file patterns to the set | ||
| Param | Type | Description | | ||
| ----- | ---- | ----------- | | ||
| --- | --- | --- | | ||
| files | <code>string</code> \| <code>Array.<string></code> | A pattern, or array of patterns to expand | | ||
<a name="module_file-set--FileSet.eFileType"></a> | ||
####enum: FileSet.eFileType → <code>number</code> | ||
#### enum: FileSet.eFileType → <code>number</code> | ||
Enum for the `type` value of each record in `fileSet.list` | ||
**Read only**: true | ||
**Properties** | ||
| Name | Type | Default | Description | | ||
| ---- | ---- | ------- |----------- | | ||
| NOEXIST | <code>number</code> | `0` | when a file doesn't exist | | ||
| FILE | <code>number</code> | `1` | It's a file | | ||
| DIR | <code>number</code> | `2` | | | ||
| --- | --- | --- | --- | | ||
| NOEXIST | <code>number</code> | <code>0</code> | when a file doesn't exist | | ||
| FILE | <code>number</code> | <code>1</code> | It's a file | | ||
| DIR | <code>number</code> | <code>2</code> | | | ||
**Read only**: true | ||
*documented by [jsdoc-to-markdown](https://github.com/75lb/jsdoc-to-markdown)* |
Sorry, the diff of this file is not supported yet
1
113
10528