doc/module-rules.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Module: rules</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="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Module: rules</h1>
<section>
<header>
<h2>
rules
</h2>
</header>
<article>
<div class="container-overview">
<dl class="details">
<dt class="tag-author">Author:</dt>
<dd class="tag-author">
<ul>
<li>Risto Stevcev</li>
</ul>
</dd>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="rules.js.html">rules.js</a>, <a href="rules.js.html#line1">line 1</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="module.exports"><span class="type-signature"><static> </span>module.exports<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
An object containing built-in rule factory functions
</div>
<dl class="details">
<h5 class="subsection-title">Properties:</h5>
<dl>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>rules.requiredOrFlags</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">A rule that compares options that must be passed separately and at least one flag is passed</td>
</tr>
<tr>
<td class="name"><code>rules.orFlags</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">A rule that compares options that must be passed separately</td>
</tr>
<tr>
<td class="name"><code>rules.andFlagSets</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">A rule that checks if a single flag in each set of flags is passed</td>
</tr>
<tr>
<td class="name"><code>rules.andFlags</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">A rule that compares options that must be passed together</td>
</tr>
<tr>
<td class="name"><code>rules.fileExists</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">A rule that checks options to see if the file path exists</td>
</tr>
</tbody>
</table></dl>
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="rules.js.html">rules.js</a>, <a href="rules.js.html#line16">line 16</a>
</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Modules</h3><ul><li><a href="module-helpers.html">helpers</a></li><li><a href="module-rules.html">rules</a></li><li><a href="module-yumparse.html">yumparse</a></li></ul><h3>Classes</h3><ul><li><a href="module-yumparse.Parser.html">Parser</a></li><li><a href="module-yumparse.Parser-YumparseError.html">YumparseError</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.2</a> on Mon Dec 29 2014 23:32:09 GMT-0800 (PST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>