npm - filehound - Versions diffs - 2.0.0-beta.2 → 2.0.0 - Mend

filehound 2.0.0-beta.2 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (212) hide show

package/README.md +39 -11
package/dist/arrays.d.ts +1 -0
package/dist/arrays.js +4 -0
package/dist/file.d.ts +108 -0
package/dist/file.js +184 -0
package/dist/filehound.d.ts +356 -0
package/dist/filehound.js +498 -0
package/dist/files.d.ts +4 -0
package/dist/files.js +37 -0
package/dist/filetype.d.ts +10 -0
package/dist/filetype.js +9 -0
package/dist/index.d.ts +5 -0
package/dist/index.js +6 -0
package/dist/matchers.d.ts +324 -0
package/dist/matchers.js +419 -0
package/dist/walker/async.d.ts +4 -0
package/dist/walker/async.js +237 -0
package/dist/walker/heap.d.ts +7 -0
package/dist/walker/heap.js +49 -0
package/dist/walker/sync.d.ts +4 -0
package/dist/walker/sync.js +66 -0
package/dist/walker/walk.d.ts +33 -0
package/dist/walker/walk.js +80 -0
package/package.json +45 -48
package/.github/stale.yml +0 -42
package/.travis.yml +0 -8
package/.vscode/launch.json +0 -21
package/.vscode/settings.json +0 -3
package/CONTRIBUTING.md +0 -8
package/_config.yml +0 -1
package/coverage/coverage.raw.json +0 -1
package/coverage/lcov-report/arrays.ts.html +0 -98
package/coverage/lcov-report/base.css +0 -212
package/coverage/lcov-report/filehound.ts.html +0 -2078
package/coverage/lcov-report/files.ts.html +0 -260
package/coverage/lcov-report/functions.ts.html +0 -122
package/coverage/lcov-report/index.html +0 -132
package/coverage/lcov-report/prettify.css +0 -1
package/coverage/lcov-report/prettify.js +0 -1
package/coverage/lcov-report/sort-arrow-sprite.png +0 -0
package/coverage/lcov-report/sorter.js +0 -158
package/coverage/lcov.info +0 -378
package/dist/src/arrays.js +0 -15
package/dist/src/arrays.js.map +0 -1
package/dist/src/asyncWalker.js +0 -59
package/dist/src/asyncWalker.js.map +0 -1
package/dist/src/bind.js +0 -15
package/dist/src/bind.js.map +0 -1
package/dist/src/filehound.js +0 -597
package/dist/src/filehound.js.map +0 -1
package/dist/src/files.js +0 -60
package/dist/src/files.js.map +0 -1
package/dist/src/matcher.js +0 -51
package/dist/src/matcher.js.map +0 -1
package/dist/src/syncWalker.js +0 -47
package/dist/src/syncWalker.js.map +0 -1
package/dist/src/walkAsync.js +0 -33
package/dist/src/walkAsync.js.map +0 -1
package/dist/src/walkSync.js +0 -21
package/dist/src/walkSync.js.map +0 -1
package/dist/src/walker/walk.js +0 -68
package/dist/src/walker/walk.js.map +0 -1
package/dist/src/walker/walkAsync.js +0 -33
package/dist/src/walker/walkAsync.js.map +0 -1
package/dist/src/walker/walkSync.js +0 -21
package/dist/src/walker/walkSync.js.map +0 -1
package/dist/test/filehound.js +0 -872
package/dist/test/filehound.js.map +0 -1
package/dist/test/files.js +0 -29
package/dist/test/files.js.map +0 -1
package/docconfig/jsdoc.json +0 -26
package/docconfig/template/LICENSE +0 -61
package/docconfig/template/README.md +0 -86
package/docconfig/template/package.json +0 -22
package/docconfig/template/publish.js +0 -676
package/docconfig/template/static/fonts/OpenSans-Bold-webfont.eot +0 -0
package/docconfig/template/static/fonts/OpenSans-Bold-webfont.svg +0 -1830
package/docconfig/template/static/fonts/OpenSans-Bold-webfont.woff +0 -0
package/docconfig/template/static/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
package/docconfig/template/static/fonts/OpenSans-BoldItalic-webfont.svg +0 -1830
package/docconfig/template/static/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
package/docconfig/template/static/fonts/OpenSans-Italic-webfont.eot +0 -0
package/docconfig/template/static/fonts/OpenSans-Italic-webfont.svg +0 -1830
package/docconfig/template/static/fonts/OpenSans-Italic-webfont.woff +0 -0
package/docconfig/template/static/fonts/OpenSans-Light-webfont.eot +0 -0
package/docconfig/template/static/fonts/OpenSans-Light-webfont.svg +0 -1831
package/docconfig/template/static/fonts/OpenSans-Light-webfont.woff +0 -0
package/docconfig/template/static/fonts/OpenSans-LightItalic-webfont.eot +0 -0
package/docconfig/template/static/fonts/OpenSans-LightItalic-webfont.svg +0 -1835
package/docconfig/template/static/fonts/OpenSans-LightItalic-webfont.woff +0 -0
package/docconfig/template/static/fonts/OpenSans-Regular-webfont.eot +0 -0
package/docconfig/template/static/fonts/OpenSans-Regular-webfont.svg +0 -1831
package/docconfig/template/static/fonts/OpenSans-Regular-webfont.woff +0 -0
package/docconfig/template/static/fonts/OpenSans-Semibold-webfont.eot +0 -0
package/docconfig/template/static/fonts/OpenSans-Semibold-webfont.svg +0 -1830
package/docconfig/template/static/fonts/OpenSans-Semibold-webfont.ttf +0 -0
package/docconfig/template/static/fonts/OpenSans-Semibold-webfont.woff +0 -0
package/docconfig/template/static/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
package/docconfig/template/static/fonts/OpenSans-SemiboldItalic-webfont.svg +0 -1830
package/docconfig/template/static/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
package/docconfig/template/static/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
package/docconfig/template/static/scripts/linenumber.js +0 -25
package/docconfig/template/static/scripts/prettify/Apache-License-2.0.txt +0 -202
package/docconfig/template/static/scripts/prettify/lang-css.js +0 -2
package/docconfig/template/static/scripts/prettify/prettify.js +0 -28
package/docconfig/template/static/styles/jsdoc-default.css +0 -605
package/docconfig/template/static/styles/prettify-jsdoc.css +0 -111
package/docconfig/template/static/styles/prettify-tomorrow.css +0 -132
package/docconfig/template/tmpl/augments.tmpl +0 -10
package/docconfig/template/tmpl/container.tmpl +0 -183
package/docconfig/template/tmpl/details.tmpl +0 -143
package/docconfig/template/tmpl/example.tmpl +0 -2
package/docconfig/template/tmpl/examples.tmpl +0 -13
package/docconfig/template/tmpl/exceptions.tmpl +0 -32
package/docconfig/template/tmpl/layout.tmpl +0 -47
package/docconfig/template/tmpl/mainpage.tmpl +0 -10
package/docconfig/template/tmpl/members.tmpl +0 -38
package/docconfig/template/tmpl/method.tmpl +0 -105
package/docconfig/template/tmpl/params.tmpl +0 -124
package/docconfig/template/tmpl/properties.tmpl +0 -108
package/docconfig/template/tmpl/returns.tmpl +0 -19
package/docconfig/template/tmpl/source.tmpl +0 -8
package/docconfig/template/tmpl/tutorial.tmpl +0 -19
package/docconfig/template/tmpl/type.tmpl +0 -7
package/docs/FileHound.html +0 -3079
package/docs/FileHound_modified.html +0 -245
package/docs/_config.yml +0 -1
package/docs/filehound.js.html +0 -697
package/docs/fonts/OpenSans-Bold-webfont.eot +0 -0
package/docs/fonts/OpenSans-Bold-webfont.svg +0 -1830
package/docs/fonts/OpenSans-Bold-webfont.woff +0 -0
package/docs/fonts/OpenSans-BoldItalic-webfont.eot +0 -0
package/docs/fonts/OpenSans-BoldItalic-webfont.svg +0 -1830
package/docs/fonts/OpenSans-BoldItalic-webfont.woff +0 -0
package/docs/fonts/OpenSans-Italic-webfont.eot +0 -0
package/docs/fonts/OpenSans-Italic-webfont.svg +0 -1830
package/docs/fonts/OpenSans-Italic-webfont.woff +0 -0
package/docs/fonts/OpenSans-Light-webfont.eot +0 -0
package/docs/fonts/OpenSans-Light-webfont.svg +0 -1831
package/docs/fonts/OpenSans-Light-webfont.woff +0 -0
package/docs/fonts/OpenSans-LightItalic-webfont.eot +0 -0
package/docs/fonts/OpenSans-LightItalic-webfont.svg +0 -1835
package/docs/fonts/OpenSans-LightItalic-webfont.woff +0 -0
package/docs/fonts/OpenSans-Regular-webfont.eot +0 -0
package/docs/fonts/OpenSans-Regular-webfont.svg +0 -1831
package/docs/fonts/OpenSans-Regular-webfont.woff +0 -0
package/docs/fonts/OpenSans-Semibold-webfont.eot +0 -0
package/docs/fonts/OpenSans-Semibold-webfont.svg +0 -1830
package/docs/fonts/OpenSans-Semibold-webfont.ttf +0 -0
package/docs/fonts/OpenSans-Semibold-webfont.woff +0 -0
package/docs/fonts/OpenSans-SemiboldItalic-webfont.eot +0 -0
package/docs/fonts/OpenSans-SemiboldItalic-webfont.svg +0 -1830
package/docs/fonts/OpenSans-SemiboldItalic-webfont.ttf +0 -0
package/docs/fonts/OpenSans-SemiboldItalic-webfont.woff +0 -0
package/docs/global.html +0 -288
package/docs/index.html +0 -154
package/docs/scripts/linenumber.js +0 -25
package/docs/scripts/prettify/Apache-License-2.0.txt +0 -202
package/docs/scripts/prettify/lang-css.js +0 -2
package/docs/scripts/prettify/prettify.js +0 -28
package/docs/styles/jsdoc-default.css +0 -605
package/docs/styles/prettify-jsdoc.css +0 -111
package/docs/styles/prettify-tomorrow.css +0 -132
package/docs.md +0 -164
package/index.js +0 -1
package/issue_template.md +0 -6
package/test/filehound.ts +0 -1076
package/test/files.ts +0 -29
package/test/fixtures/custom/failed.txt +0 -0
package/test/fixtures/custom/passed.txt +0 -0
package/test/fixtures/deeplyNested/c.json +0 -0
package/test/fixtures/deeplyNested/d.json +0 -0
package/test/fixtures/deeplyNested/mydir/e.json +0 -0
package/test/fixtures/deeplyNested/mydir/mydir2/f.json +0 -0
package/test/fixtures/deeplyNested/mydir/mydir2/mydir3/mydir4/failed.json +0 -0
package/test/fixtures/deeplyNested/mydir/mydir2/mydir3/z.json +0 -0
package/test/fixtures/deeplyNested/mydir/mydir2/y.json +0 -0
package/test/fixtures/deeplyNestedWithHiddenDir/c.json +0 -0
package/test/fixtures/deeplyNestedWithHiddenDir/d.json +0 -0
package/test/fixtures/deeplyNestedWithHiddenDir/mydir/e.json +0 -0
package/test/fixtures/deeplyNestedWithHiddenDir/mydir/mydir2/f.json +0 -0
package/test/fixtures/deeplyNestedWithHiddenDir/mydir/mydir2/mydir3/mydir4/.mydir5/.keep +0 -0
package/test/fixtures/deeplyNestedWithHiddenDir/mydir/mydir2/mydir3/mydir4/failed.json +0 -0
package/test/fixtures/deeplyNestedWithHiddenDir/mydir/mydir2/mydir3/z.json +0 -0
package/test/fixtures/deeplyNestedWithHiddenDir/mydir/mydir2/y.json +0 -0
package/test/fixtures/ext/Dummy.java +0 -0
package/test/fixtures/ext/Dumpy.go +0 -0
package/test/fixtures/ext/dummy.json +0 -0
package/test/fixtures/ext/dummy.txt +0 -0
package/test/fixtures/justFiles/a.json +0 -0
package/test/fixtures/justFiles/b.json +0 -0
package/test/fixtures/justFiles/dummy.txt +0 -0
package/test/fixtures/mixed/a.json +0 -0
package/test/fixtures/mixed/aabbcc.json +0 -0
package/test/fixtures/mixed/ab.json +0 -0
package/test/fixtures/mixed/z.json +0 -0
package/test/fixtures/nested/.hidden1/bad.txt +0 -0
package/test/fixtures/nested/c.json +0 -0
package/test/fixtures/nested/d.json +0 -0
package/test/fixtures/nested/mydir/e.json +0 -0
package/test/fixtures/sizes/10b.txt +0 -0
package/test/fixtures/sizes/1b.txt +0 -0
package/test/fixtures/sizes/1k.txt +0 -0
package/test/fixtures/sizes/2k.txt +0 -0
package/test/fixtures/visibility/.hidden/.hidden.json +0 -0
package/test/fixtures/visibility/.hidden/visible.json +0 -3
package/test/fixtures/visibility/.hidden.json +0 -3
package/test/fixtures/visibility/visible/.hidden.json +0 -3
package/test/fixtures/visibility/visible.json +0 -3
package/test/mocha.opts +0 -4
package/tsconfig.json +0 -16
package/tslint.json +0 -44

package/docs/FileHound.html DELETED Viewed

@@ -1,3079 +0,0 @@
-<!DOCTYPE html>
-<html lang="en">
-<head>
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width,initial-scale=1">
-    <title>FileHound - Documentation</title>
-    <script src="scripts/prettify/prettify.js"></script>
-    <script src="scripts/prettify/lang-css.js"></script>
-    <!--[if lt IE 9]>
-      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
-    <![endif]-->
-    <link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
-    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
-    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
-</head>
-<body>
-<input type="checkbox" id="nav-trigger" class="nav-trigger" />
-<label for="nav-trigger" class="navicon-button x">
-  <div class="navicon"></div>
-</label>
-<label for="nav-trigger" class="overlay"></label>
-<nav>
-    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FileHound.html">FileHound</a><ul class='methods'><li data-type='method'><a href="FileHound.html#.accessed">accessed</a></li><li data-type='method'><a href="FileHound.html#.any">any</a></li><li data-type='method'><a href="FileHound.html#.create">create</a></li><li data-type='method'><a href="FileHound.html#.modified">modified</a></li><li data-type='method'><a href="FileHound.html#addFilter">addFilter</a></li><li data-type='method'><a href="FileHound.html#changed">changed</a></li><li data-type='method'><a href="FileHound.html#depth">depth</a></li><li data-type='method'><a href="FileHound.html#directory">directory</a></li><li data-type='method'><a href="FileHound.html#discard">discard</a></li><li data-type='method'><a href="FileHound.html#ext">ext</a></li><li data-type='method'><a href="FileHound.html#find">find</a></li><li data-type='method'><a href="FileHound.html#findSync">findSync</a></li><li data-type='method'><a href="FileHound.html#glob">glob</a></li><li data-type='method'><a href="FileHound.html#ignoreHiddenDirectories">ignoreHiddenDirectories</a></li><li data-type='method'><a href="FileHound.html#ignoreHiddenFiles">ignoreHiddenFiles</a></li><li data-type='method'><a href="FileHound.html#isEmpty">isEmpty</a></li><li data-type='method'><a href="FileHound.html#match">match</a></li><li data-type='method'><a href="FileHound.html#not">not</a></li><li data-type='method'><a href="FileHound.html#path">path</a></li><li data-type='method'><a href="FileHound.html#paths">paths</a></li><li data-type='method'><a href="FileHound.html#size">size</a></li><li data-type='method'><a href="FileHound.html#socket">socket</a></li></ul></li></ul>
-</nav>
-<div id="main">
-    <h1 class="page-title">FileHound</h1>
-<section>
-<header>
-        <h2>
-        FileHound
-        </h2>
-</header>
-<article>
-    <div class="container-overview">
-    <h4 class="name" id="FileHound"><span class="type-signature"></span>new FileHound<span class="signature">()</span><span class="type-signature"></span></h4>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line42">line 42</a>
-    </li></ul></dd>
-</dl>
-    </div>
-        <h3 class="subsection-title">Methods</h3>
-    <h4 class="name" id=".accessed"><span class="type-signature">(static) </span>accessed<span class="signature">(dateExpression)</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Filters by file access time</p>
-</div>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>dateExpression</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-            <td class="description last"><p>date expression</p></td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line118">line 118</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>a FileHound instance</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-const filehound = FileHound.create();
-filehound
-  .accessed("&lt; 10 minutes")
-  .find()
-  .each(console.log);</code></pre>
-    <h4 class="name" id=".any"><span class="type-signature">(static) </span>any<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Returns all matches from one of more FileHound instances</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line72">line 72</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>a promise containing all matches. If the Promise fulfils,
-the fulfilment value is an array of all matching files.</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-const filehound = FileHound.any(fh1, fh2);</code></pre>
-    <h4 class="name" id=".create"><span class="type-signature">(static) </span>create<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Static factory method to create an instance of FileHound</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line55">line 55</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>FileHound instance</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-const filehound = FileHound.create();</code></pre>
-    <h4 class="name" id=".modified"><span class="type-signature">(static) </span>modified<span class="signature">(dateExpression)</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Filters by modifiction time</p>
-</div>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>dateExpression</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-            <td class="description last"><p>date expression</p></td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line94">line 94</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>a FileHound instance</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-const filehound = FileHound.create();
-filehound
-  .modified("&lt; 2 days")
-  .find()
-  .each(console.log);</code></pre>
-    <h4 class="name" id="addFilter"><span class="type-signature"></span>addFilter<span class="signature">(function)</span><span class="type-signature"></span></h4>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>function</code></td>
-            <td class="type">
-<span class="param-type">function</span>
-            </td>
-            <td class="description last"><p>custom filter function</p></td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line167">line 167</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>a FileHound instance</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-const filehound = FileHound.create();
-filehound
-  .addFilter(customFilter)
-  .find()
-  .each(consoe.log);</code></pre>
-    <h4 class="name" id="changed"><span class="type-signature"></span>changed<span class="signature">(dateExpression)</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Filters change time</p>
-</div>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>dateExpression</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-            <td class="description last"><p>date expression</p></td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line142">line 142</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>a FileHound instance</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-const filehound = FileHound.create();
-filehound
-  .changed("&lt; 10 minutes")
-  .find()
-  .each(console.log);</code></pre>
-    <h4 class="name" id="depth"><span class="type-signature"></span>depth<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Specify the directory search depth. If set to zero, recursive searching
-will be disabled</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line484">line 484</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>a FileHound instance</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-const filehound = FileHound.create();
-filehound
-  .depth(0)
-  .find()
-  .each(console.log); // array of files names only in the current directory</code></pre>
-    <h4 class="name" id="directory"><span class="type-signature"></span>directory<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Find sub-directories</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line441">line 441</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>a FileHound instance</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-const filehound = FileHound.create();
-filehound
-  .directory()
-  .find()
-  .each(console.log); // array of matching sub-directories</code></pre>
-    <h4 class="name" id="discard"><span class="type-signature"></span>discard<span class="signature">(regex)</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Ignores files or sub-directories matching pattern</p>
-</div>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>regex</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-|
-<span class="param-type">array</span>
-            </td>
-            <td class="description last"><p>regex or array of regex</p></td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line234">line 234</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>a FileHound instance</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-const filehound = FileHound.create();
-filehound
-  .discard("*.tmp*")
-  .find()
-  .each(console.log);</code></pre>
-    <h4 class="name" id="ext"><span class="type-signature"></span>ext<span class="signature">(extensions)</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Filter on file extension</p>
-</div>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>extensions</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-|
-<span class="param-type">array</span>
-            </td>
-            <td class="description last"><p>extension or an array of extensions</p></td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line260">line 260</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>a FileHound instance</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-let filehound = FileHound.create();
-filehound
-  .ext(".json")
-  .find()
-  .each(console.log);
-// array of extensions to filter by
-filehound = FileHound.create();
-filehound
-  .ext([".json", ".txt"])
-  .find()
-  .each(console.log);
-// supports var args
-filehound = FileHound.create();
-filehound
-  .ext(".json", ".txt")
-  .find()
-  .each(console.log);</code></pre>
-    <h4 class="name" id="find"><span class="type-signature"></span>find<span class="signature">(function)</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Asynchronously executes a file search.</p>
-</div>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>function</code></td>
-            <td class="type">
-<span class="param-type">function</span>
-            </td>
-            <td class="description last"><p>Optionally accepts a callback function</p></td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line507">line 507</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>Returns a Promise of all matches. If the Promise fulfils,
-the fulfilment value is an array of all matching files</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-const filehound = FileHound.create();
-filehound
-  .find()
-  .each(console.log);
-// using a callback
-filehound
-  .find((err, files) => {
-     if (err) return console.error(err);
-     console.log(files);
-  });</code></pre>
-    <h4 class="name" id="findSync"><span class="type-signature"></span>findSync<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Synchronously executes a file search.</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line548">line 548</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>Returns an array of all matching files</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-const filehound = FileHound.create();
-const files = filehound.findSync();
-console.log(files);</code></pre>
-    <h4 class="name" id="glob"><span class="type-signature"></span>glob<span class="signature">(glob)</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Filter by a file glob</p>
-</div>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>glob</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-            <td class="description last"><p>file glob</p></td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line344">line 344</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>a FileHound instance</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-const filehound = FileHound.create();
-filehound
-  .glob("*tmp*")
-  .find()
-  .each(console.log); // array of files names all containing 'tmp'</code></pre>
-    <h4 class="name" id="ignoreHiddenDirectories"><span class="type-signature"></span>ignoreHiddenDirectories<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Ignore hidden directories</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line419">line 419</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>a FileHound instance</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-const filehound = FileHound.create();
-filehound
-  .ignoreHiddenDirectories()
-  .find()
-  .each(console.log); // array of files names that are not hidden directories</code></pre>
-    <h4 class="name" id="ignoreHiddenFiles"><span class="type-signature"></span>ignoreHiddenFiles<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Filter to ignore hidden files</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line398">line 398</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>a FileHound instance</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-const filehound = FileHound.create();
-filehound
-  .ignoreHiddenFiles()
-  .find()
-  .each(console.log); // array of files names that are not hidden files</code></pre>
-    <h4 class="name" id="isEmpty"><span class="type-signature"></span>isEmpty<span class="signature">(path)</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Filter by zero length files</p>
-</div>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>path</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-            <td class="description last"><p>path</p></td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line322">line 322</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>a FileHound instance</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-const filehound = FileHound.create();
-filehound
-  .size("&lt;10kb")
-  .find()
-  .each(console.log);</code></pre>
-    <h4 class="name" id="match"><span class="type-signature"></span>match<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Same as glob</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line370">line 370</a>
-    </li></ul></dd>
-    <dt class="tag-see">See:</dt>
-    <dd class="tag-see">
-        <ul>
-            <li>glob</li>
-        </ul>
-    </dd>
-</dl>
-    <h4 class="name" id="not"><span class="type-signature"></span>not<span class="signature">(glob)</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Negates filters</p>
-</div>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>glob</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-            <td class="description last"><p>file glob</p></td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line374">line 374</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>a FileHound instance</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-const filehound = FileHound.create();
-filehound
-  .not()
-  .glob("*tmp*")
-  .find()
-  .each(console.log); // array of files names NOT containing 'tmp'</code></pre>
-    <h4 class="name" id="path"><span class="type-signature"></span>path<span class="signature">(path)</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Define the search path</p>
-</div>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>path</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-            <td class="description last"><p>path</p></td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line212">line 212</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>a FileHound instance</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-const filehound = FileHound.create();
-filehound
-  .path("/tmp")
-  .find()
-  .each(console.log);</code></pre>
-    <h4 class="name" id="paths"><span class="type-signature"></span>paths<span class="signature">(path)</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Defines the search paths</p>
-</div>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>path</code></td>
-            <td class="type">
-<span class="param-type">array</span>
-            </td>
-            <td class="description last"><p>array of paths</p></td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line189">line 189</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>a FileHound instance</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-const filehound = FileHound.create();
-filehound
-  .paths("/tmp", "/etc") // or ["/tmp", "/etc"]
-  .find()
-  .each(console.log);</code></pre>
-    <h4 class="name" id="size"><span class="type-signature"></span>size<span class="signature">(sizeExpression)</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Filter by file size</p>
-</div>
-    <h5>Parameters:</h5>
-<table class="params">
-    <thead>
-    <tr>
-        <th>Name</th>
-        <th>Type</th>
-        <th class="last">Description</th>
-    </tr>
-    </thead>
-    <tbody>
-        <tr>
-                <td class="name"><code>sizeExpression</code></td>
-            <td class="type">
-<span class="param-type">string</span>
-            </td>
-            <td class="description last"><p>a size expression</p></td>
-        </tr>
-    </tbody>
-</table>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line297">line 297</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>a FileHound instance</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-const filehound = FileHound.create();
-filehound
-  .size("&lt;10kb")
-  .find()
-  .each(console.log);</code></pre>
-    <h4 class="name" id="socket"><span class="type-signature"></span>socket<span class="signature">()</span><span class="type-signature"></span></h4>
-<div class="description">
-    <p>Find sockets</p>
-</div>
-<dl class="details">
-    <dt class="tag-source">Source:</dt>
-    <dd class="tag-source"><ul class="dummy"><li>
-        <a href="filehound.js.html">filehound.js</a>, <a href="filehound.js.html#line463">line 463</a>
-    </li></ul></dd>
-</dl>
-<h5>Returns:</h5>
-<div class="param-desc">
-    <p>a FileHound instance</p>
-</div>
-    <h5>Example</h5>
-    <pre class="prettyprint"><code>import FileHound from 'filehound';
-const filehound = FileHound.create();
-filehound
-  .socket()
-  .find()
-  .each(console.log); // array of matching sockets</code></pre>
-</article>
-</section>
-</div>
-<br class="clear">
-<footer>
-    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Fri Jan 05 2018 11:12:21 GMT+0000 (GMT) using the Minami theme.
-</footer>
-<script>prettyPrint();</script>
-<script src="scripts/linenumber.js"></script>
-</body>
-</html>