filehound
Version:
Find files the easy way
3,095 lines (692 loc) • 38.7 kB
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#includeFileStats">includeFileStats</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#line53">line 53</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#line126">line 126</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("< 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#line82">line 82</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#line65">line 65</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#line101">line 101</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("< 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#line177">line 177</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(console.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#line151">line 151</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("< 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#line552">line 552</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#line506">line 506</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#line244">line 244</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#line270">line 270</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#line575">line 575</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#line621">line 621</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">array</span>
</td>
<td class="description last"><p>array of globs</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#line360">line 360</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*']) // .glob('*tmp*') || .glob('*tmp1*','*tmp2*')
.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#line462">line 462</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#line438">line 438</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="includeFileStats"><span class="type-signature"></span>includeFileStats<span class="signature">()</span><span class="type-signature"></span></h4>
<div class="description">
<p>Include file stats</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
.includeFileStats()
.find()
.each(console.log); // array of file objects containing `path` and `stats` properties</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#line337">line 337</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("<10kb")
.find()
.each(console.log);</code></pre>
<h4 class="name" id="match"><span class="type-signature"></span>match<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">array</span>
</td>
<td class="description last"><p>array of globs</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#line382">line 382</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
.match(['*tmp*']) // .match('*tmp*')
.find()
.each(console.log); // array of files names all containing 'tmp'</code></pre>
<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#line414">line 414</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#line222">line 222</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#line199">line 199</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#line311">line 311</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("<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#line528">line 528</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.6.5</a> on Wed Aug 05 2020 13:26:06 GMT+0200 (Central European Summer Time) using the Minami theme.
</footer>
<script>prettyPrint();</script>
<script src="scripts/linenumber.js"></script>
</body>
</html>