fluentnode
Version:
Fluent apis for node (based on the concepts used in C#'s FluentSharp
468 lines (297 loc) • 14.9 kB
HTML
<html>
<head>
<title>assert_Number.litcoffee</title>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<meta name="viewport" content="width=device-width, target-densitydpi=160dpi, initial-scale=1.0; maximum-scale=1.0; user-scalable=0;">
<link rel="stylesheet" media="all" href="docco.css" />
</head>
<body>
<div id="container">
<div id="background"></div>
<ul id="jump_to">
<li>
<a class="large" href="javascript:void(0);">Jump To …</a>
<a class="small" href="javascript:void(0);">+</a>
<div id="jump_wrapper">
<div id="jump_page">
<a class="source" href="assert_Array.html">
assert_Array.litcoffee
</a>
<a class="source" href="assert_Boolean.html">
assert_Boolean.litcoffee
</a>
<a class="source" href="assert_Function.html">
assert_Function.litcoffee
</a>
<a class="source" href="assert_Number.html">
assert_Number.litcoffee
</a>
<a class="source" href="assert_Object.html">
assert_Object.litcoffee
</a>
<a class="source" href="assert_String.html">
assert_String.litcoffee
</a>
<a class="source" href="fluentnode.html">
fluentnode.coffee
</a>
<a class="source" href="index.html">
index.md
</a>
<a class="source" href="Array.html">
Array.litcoffee
</a>
<a class="source" href="Boolean.html">
Boolean.litcoffee
</a>
<a class="source" href="Function.html">
Function.litcoffee
</a>
<a class="source" href="Number.html">
Number.litcoffee
</a>
<a class="source" href="Object.html">
Object.litcoffee
</a>
<a class="source" href="String.html">
String.litcoffee
</a>
<a class="source" href="console.html">
console.litcoffee
</a>
<a class="source" href="crypto.html">
crypto.litcoffee
</a>
<a class="source" href="fs.html">
fs.litcoffee
</a>
<a class="source" href="http.GET.html">
http.GET.litcoffee
</a>
<a class="source" href="http.POST.html">
http.POST.litcoffee
</a>
<a class="source" href="http.Server.html">
http.Server.litcoffee
</a>
<a class="source" href="http.html">
http.litcoffee
</a>
<a class="source" href="path.html">
path.litcoffee
</a>
<a class="source" href="process.html">
process.litcoffee
</a>
<a class="source" href="encoding.html">
encoding.litcoffee
</a>
<a class="source" href="globals.html">
globals.litcoffee
</a>
<a class="source" href="assert_Array.test.html">
assert_Array.test.coffee
</a>
<a class="source" href="assert_Boolean.test.html">
assert_Boolean.test.coffee
</a>
<a class="source" href="assert_Function.test.html">
assert_Function.test.coffee
</a>
<a class="source" href="assert_Number.test.html">
assert_Number.test.coffee
</a>
<a class="source" href="assert_Object.test.html">
assert_Object.test.coffee
</a>
<a class="source" href="assert_String.test.html">
assert_String.test.coffee
</a>
<a class="source" href="fluentnode.test.html">
fluentnode.test.coffee
</a>
<a class="source" href="Array.test.html">
Array.test.coffee
</a>
<a class="source" href="Boolean.test.html">
Boolean.test.coffee
</a>
<a class="source" href="Function.test.html">
Function.test.coffee
</a>
<a class="source" href="Number.test.html">
Number.test.coffee
</a>
<a class="source" href="Object.test.html">
Object.test.coffee
</a>
<a class="source" href="String.test.html">
String.test.coffee
</a>
<a class="source" href="console.test.html">
console.test.coffee
</a>
<a class="source" href="crypto.test.html">
crypto.test.coffee
</a>
<a class="source" href="fs.test.html">
fs.test.coffee
</a>
<a class="source" href="http.GET.test.html">
http.GET.test.coffee
</a>
<a class="source" href="http.POST.test.html">
http.POST.test.coffee
</a>
<a class="source" href="http.Server.test.html">
http.Server.test.coffee
</a>
<a class="source" href="http.test.html">
http.test.coffee
</a>
<a class="source" href="path.test.html">
path.test.coffee
</a>
<a class="source" href="process.test.html">
process.test.coffee
</a>
<a class="source" href="encoding.test.html">
encoding.test.coffee
</a>
<a class="source" href="globals.test.html">
globals.test.coffee
</a>
</div>
</li>
</ul>
<ul class="sections">
<li id="title">
<div class="annotation">
<h1>assert_Number.litcoffee</h1>
</div>
</li>
<li id="section-1">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-1">¶</a>
</div>
<p>dependencies</p>
</div>
<div class="content"><div class='highlight'><pre>assert = <span class="hljs-built_in">require</span> <span class="hljs-string">'assert'</span></pre></div></div>
</li>
<li id="section-2">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-2">¶</a>
</div>
<p>Note: the @ represents this</p>
<p>@.<strong>assert_Bigger_Than</strong> value</p>
<p>twin methods: assert_Above, assert_Is_Bigger</p>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-attribute">Number</span>::assert_Bigger_Than = <span class="hljs-function"><span class="hljs-params">(value)</span>-></span>
value.assert_Is_Number()
(@ > value).assert_Is_True(<span class="hljs-string">"<span class="hljs-subst">#{@}</span> was not bigger than <span class="hljs-subst">#{value}</span>"</span>)
<span class="hljs-attribute">Number</span>::assert_Above = <span class="hljs-attribute">Number</span>::assert_Bigger_Than
<span class="hljs-attribute">Number</span>::assert_Is_Bigger_Than = <span class="hljs-attribute">Number</span>::assert_Bigger_Than</pre></div></div>
</li>
<li id="section-3">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-3">¶</a>
</div>
<p>@.<strong>assert_In_Between</strong></p>
<p>asserts that @ is in between <strong>min</strong> and <strong>max</strong></p>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-attribute">Number</span>::assert_In_Between = <span class="hljs-function"><span class="hljs-params">(min,max )</span>-></span>
message = <span class="hljs-string">"Expected <span class="hljs-subst">#{@}</span> to be between <span class="hljs-subst">#{min}</span> and <span class="hljs-subst">#{max}</span>"</span>
@.in_Between(min,max).assert_Is_True(message)
@</pre></div></div>
</li>
<li id="section-4">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-4">¶</a>
</div>
<p>@.<strong>assert_Is_Equal_To</strong> target</p>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-attribute">Number</span>::assert_Is_Equal_To = <span class="hljs-function"><span class="hljs-params">(target)</span>-></span>
source = @
assert.equal(source, target)
@</pre></div></div>
</li>
<li id="section-5">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-5">¶</a>
</div>
<p>@.<strong>assert_Is_Not_Equal_To</strong> target</p>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-attribute">Number</span>::assert_Is_Not_Equal_To = <span class="hljs-function"><span class="hljs-params">(target, message)</span>-></span>
source = @
assert.notEqual(source, target, message)
@</pre></div></div>
</li>
<li id="section-6">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-6">¶</a>
</div>
<p>@.<strong>assert_Is_Number</strong></p>
<p>When checking if is @ is a number, it seems that the only thing we can do
it to check if @ is NaN (which should not be accepetd)</p>
<p>See see issue <a href="https://github.com/o2platform/fluentnode/issues/57">https://github.com/o2platform/fluentnode/issues/57</a></p>
<p>note that <code>Number('').assert_Is_Number().assert_Is 0</code></p>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-attribute">Number</span>::assert_Is_Number = <span class="hljs-function"><span class="hljs-params">()</span>-></span>
@.str().assert_Is_Not <span class="hljs-string">'NaN'</span> , <span class="hljs-string">'The provided number was a NaN (Not an Number)'</span>
@</pre></div></div>
</li>
<li id="section-7">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-7">¶</a>
</div>
<p>@.<strong>assert_Is</strong> target</p>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-attribute">Number</span>::assert_Is = <span class="hljs-attribute">Number</span>::assert_Is_Equal_To</pre></div></div>
</li>
<li id="section-8">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-8">¶</a>
</div>
<p>@.<strong>assert_Is_Not</strong> target</p>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-attribute">Number</span>::assert_Is_Not = <span class="hljs-attribute">Number</span>::assert_Is_Not_Equal_To</pre></div></div>
</li>
<li id="section-9">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-9">¶</a>
</div>
<p><strong>assert_Smaller_Than</strong> value</p>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-attribute">Number</span>::assert_Smaller_Than = <span class="hljs-function"><span class="hljs-params">(value)</span>-></span>
(@ < value).assert_Is_True()</pre></div></div>
</li>
<li id="section-10">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-10">¶</a>
</div>
<hr>
</div>
</li>
<li id="section-11">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-11">¶</a>
</div>
<p>back to <a href="index.html">index</a></p>
</div>
</li>
</ul>
</div>
</body>
</html>