fluentnode
Version:
Fluent apis for node (based on the concepts used in C#'s FluentSharp
410 lines (261 loc) • 12.9 kB
HTML
<html>
<head>
<title>globals.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>globals.litcoffee</h1>
</div>
</li>
<li id="section-1">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-1">¶</a>
</div>
<p>##global methods</p>
<p>These are helper methods that are added to the global object, the main reason is that they can handle null values,
where the normal prototypes are not able to detect that (in a controlled way)</p>
<p><strong>existy</strong> value</p>
<p>confirms that a <code>value</code> exists (i.e. is not null or undefined)</p>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-built_in">global</span>.existy = <span class="hljs-function"><span class="hljs-params">(value)</span>-></span>
value?
<span class="hljs-built_in">global</span>.not_Null = <span class="hljs-built_in">global</span>.existy</pre></div></div>
</li>
<li id="section-2">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-2">¶</a>
</div>
<p><strong>is_Number</strong></p>
<p>returns true if <code>value</code> is an number or not NaN</p>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-built_in">global</span>.is_Number = <span class="hljs-function"><span class="hljs-params">(value)</span>-></span>
(<span class="hljs-keyword">typeof</span> value <span class="hljs-keyword">is</span> <span class="hljs-string">'number'</span>) <span class="hljs-keyword">and</span> value.is_Number()</pre></div></div>
</li>
<li id="section-3">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-3">¶</a>
</div>
<p><strong>is_Null</strong></p>
<p>returns true if <code>value</code> is null</p>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-built_in">global</span>.is_Null = <span class="hljs-function"><span class="hljs-params">(value)</span>-></span>
value <span class="hljs-keyword">is</span> <span class="hljs-literal">null</span></pre></div></div>
</li>
<li id="section-4">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-4">¶</a>
</div>
<p><strong>file_Exists</strong> file</p>
<p>Returns true if <code>file</code> exists</p>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-built_in">global</span>.file_Exists = <span class="hljs-function"><span class="hljs-params">(file)</span>-></span>
<span class="hljs-keyword">if</span> not_Null(file)
file.file_Exists()
<span class="hljs-keyword">else</span>
<span class="hljs-literal">false</span></pre></div></div>
</li>
<li id="section-5">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-5">¶</a>
</div>
<p><strong>using</strong> target,callback</p>
<p>simulates a ‘using’ or ‘with’ language feaure where the this object (inside callback)
is changed to <code>value</code></p>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-built_in">global</span>.using = <span class="hljs-function"><span class="hljs-params">(target,callback)</span>-></span>
callback.apply(target)</pre></div></div>
</li>
<li id="section-6">
<div class="annotation">
<div class="pilwrap ">
<a class="pilcrow" href="#section-6">¶</a>
</div>
<p><strong>truthly</strong> value</p>
<p>Returns true if <code>value</code> exists and is not false</p>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-built_in">global</span>.truthly = <span class="hljs-function"><span class="hljs-params">(value)</span>-></span>
value? <span class="hljs-keyword">and</span> value != <span class="hljs-literal">false</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>log</strong> message</p>
<p>Simple wrapper for console.log</p>
</div>
<div class="content"><div class='highlight'><pre><span class="hljs-built_in">global</span>.log = <span class="hljs-built_in">console</span>.log</pre></div></div>
</li>
</ul>
</div>
</body>
</html>