specify-assertions
Version:
Beautiful assertion library.
1,074 lines (297 loc) • 14.5 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>Specify (assertions) Module: specify-assertions/lib/validations</title>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/sunlight.default.css">
<link type="text/css" rel="stylesheet" href="styles/site.cerulean.css">
</head>
<body>
<div class="container-fluid">
<div class="navbar navbar-fixed-top ">
<div class="navbar-inner">
<a class="brand" href="index.html">Specify (assertions)</a>
<ul class="nav">
<li class="dropdown">
<a href="namespaces.list.html" class="dropdown-toggle" data-toggle="dropdown">Namespaces<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="divergence.Divergence_.html">Divergence</a>
</li>
</ul>
</li>
<li class="dropdown">
<a href="modules.list.html" class="dropdown-toggle" data-toggle="dropdown">Modules<b
class="caret"></b></a>
<ul class="dropdown-menu ">
<li>
<a href="divergence.html">specify-assertions/lib/divergence</a>
</li>
<li>
<a href="index_.html">specify-assertions/lib/index</a>
</li>
<li>
<a href="validations.html">specify-assertions/lib/validations</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
<div class="row-fluid">
<div class="span8">
<div id="main">
<h1 class="page-title">Module: specify-assertions/lib/validations</h1>
<section>
<header>
<h2>
specify-assertions/lib/validations
</h2>
</header>
<article>
<div class="container-overview">
<div class="description"><p>Provides common validation functions.</p></div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="validations.js.html">validations.js</a>, <a href="validations.js.html#sunlight-1-line-1">line 1</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="assert"><span class="type-signature"><static> </span>assert<span class="signature">()</span><span class="type-signature"></span></h4>
<p class="summary">Boolean → Divergence → Object → Validation[Divergence, Divergence]</p>
</dt>
<dd>
<div class="description">
<p>Makes an assertion about a piece of data.</p>
<p>This is a low-level method, and should be only used as a basis for
constructing higher-level validations, not as a validation itself.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="validations.js.html">validations.js</a>, <a href="validations.js.html#sunlight-1-line-32">line 32</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="contain"><span class="type-signature"><static> </span>contain<span class="signature">()</span><span class="type-signature"></span></h4>
<p class="summary">α → Sequence[α] → Validation[Divergence, Divergence]</p>
</dt>
<dd>
<div class="description">
<p>Asserts that a contains something as a value.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="validations.js.html">validations.js</a>, <a href="validations.js.html#sunlight-1-line-207">line 207</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="equal"><span class="type-signature"><static> </span>equal<span class="signature">()</span><span class="type-signature"></span></h4>
<p class="summary">α → β → Validation[Divergence, Divergence]</p>
</dt>
<dd>
<div class="description">
<p>Asserts structural (deep) equality between two values.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="validations.js.html">validations.js</a>, <a href="validations.js.html#sunlight-1-line-119">line 119</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="have"><span class="type-signature"><static> </span>have<span class="signature">()</span><span class="type-signature"></span></h4>
<p class="summary">String → Object → Validation[Divergence, Divergence]</p>
</dt>
<dd>
<div class="description">
<p>Asserts that a value has a certain property.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="validations.js.html">validations.js</a>, <a href="validations.js.html#sunlight-1-line-235">line 235</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="haveClass"><span class="type-signature"><static> </span>haveClass<span class="signature">()</span><span class="type-signature"></span></h4>
<p class="summary">String → α → Validation[Divergence, Divergence]</p>
</dt>
<dd>
<div class="description">
<p>Asserts that something has a certain internal <code>[[Class]]</code>.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="validations.js.html">validations.js</a>, <a href="validations.js.html#sunlight-1-line-175">line 175</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="haveType"><span class="type-signature"><static> </span>haveType<span class="signature">()</span><span class="type-signature"></span></h4>
<p class="summary">String → α → Validation[Divergence, Divergence]</p>
</dt>
<dd>
<div class="description">
<p>Asserts that something is of a certain type (according to <code>typeof</code>).</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="validations.js.html">validations.js</a>, <a href="validations.js.html#sunlight-1-line-161">line 161</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="inheritFrom"><span class="type-signature"><static> </span>inheritFrom<span class="signature">()</span><span class="type-signature"></span></h4>
<p class="summary">Object → Object → Validation[Divergence, Divergence]</p>
</dt>
<dd>
<div class="description">
<p>Asserts that something has another thing in its prototype chain.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="validations.js.html">validations.js</a>, <a href="validations.js.html#sunlight-1-line-192">line 192</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="match"><span class="type-signature"><static> </span>match<span class="signature">()</span><span class="type-signature"></span></h4>
<p class="summary">RegExp → String → Validation[Divergence, Divergence]</p>
</dt>
<dd>
<div class="description">
<p>Asserts that a value matches a regular expression.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="validations.js.html">validations.js</a>, <a href="validations.js.html#sunlight-1-line-221">line 221</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="not"><span class="type-signature"><static> </span>not<span class="signature">()</span><span class="type-signature"></span></h4>
<p class="summary">(α → Validation[Divergence, Divergence]) → α → Validation[Divergence, Divergence]</p>
</dt>
<dd>
<div class="description">
<p>Negates an assertion function.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="validations.js.html">validations.js</a>, <a href="validations.js.html#sunlight-1-line-107">line 107</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="ok"><span class="type-signature"><static> </span>ok<span class="signature">()</span><span class="type-signature"></span></h4>
<p class="summary">α → Validation[Divergence, Divergence]</p>
</dt>
<dd>
<div class="description">
<p>Asserts that something is truthy.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="validations.js.html">validations.js</a>, <a href="validations.js.html#sunlight-1-line-133">line 133</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="raise"><span class="type-signature"><static> </span>raise<span class="signature">()</span><span class="type-signature"></span></h4>
<p class="summary">Error → (Void → Void :: partial) → Validation[Divergence, Divergence]</p>
</dt>
<dd>
<div class="description">
<p>Asserts that a computation throws a particular exception.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="validations.js.html">validations.js</a>, <a href="validations.js.html#sunlight-1-line-249">line 249</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="strictEqual"><span class="type-signature"><static> </span>strictEqual<span class="signature">()</span><span class="type-signature"></span></h4>
<p class="summary">α → β → Validation[Divergence, Divergence]</p>
</dt>
<dd>
<div class="description">
<p>Asserts strict equality (===) between two values.</p>
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="validations.js.html">validations.js</a>, <a href="validations.js.html#sunlight-1-line-147">line 147</a>
</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<div class="clearfix"></div>
<footer>
<span class="copyright">
© 2014 Origami Tower
</span>
<br />
<span class="jsdoc-message">
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha9</a>
on Thu Dec 25 2014 14:27:25 GMT-0200 (BRST) using the <a href="https://github.com/terryweiss/docstrap">DocStrap template</a>.
</span>
</footer>
</div>
<div class="span3">
<div id="toc"></div>
</div>
<br clear="both">
</div>
</div>
<script src="scripts/sunlight.js"></script>
<script src="scripts/sunlight.javascript.js"></script>
<script src="scripts/sunlight-plugin.doclinks.js"></script>
<script src="scripts/sunlight-plugin.linenumbers.js"></script>
<script src="scripts/sunlight-plugin.menu.js"></script>
<script src="scripts/jquery.min.js"></script>
<script src="scripts/jquery.scrollTo.js"></script>
<script src="scripts/jquery.localScroll.js"></script>
<script src="scripts/bootstrap-dropdown.js"></script>
<script src="scripts/toc.js"></script>
<script> Sunlight.highlightAll({lineNumbers:true, showMenu: true, enableDoclinks :true}); </script>
<script>
$( function () {
$( "#toc" ).toc( {
anchorName : function(i, heading, prefix) {
return $(heading).attr("id") || ( prefix + i );
},
selectors : "h1,h2,h3,h4",
showAndHide : false,
scrollTo : 60
} );
$( "#toc>ul" ).addClass( "nav nav-pills nav-stacked" );
$( "#main span[id^='toc']" ).addClass( "toc-shim" );
} );
</script>
</body>
</html>