UNPKG

fluentnode

Version:

Fluent apis for node (based on the concepts used in C#'s FluentSharp

474 lines (297 loc) 15 kB
<!DOCTYPE html> <html> <head> <title>path.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 &hellip;</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>path.litcoffee</h1> </div> </li> <li id="section-1"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-1">&#182;</a> </div> </div> <div class="content"><div class='highlight'><pre>path = <span class="hljs-built_in">require</span>(<span class="hljs-string">'path'</span>)</pre></div></div> </li> <li id="section-2"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-2">&#182;</a> </div> <p>@.<strong>path_Combine</strong></p> </div> <div class="content"><div class='highlight'><pre><span class="hljs-attribute">String</span>::path_Combine = <span class="hljs-function"><span class="hljs-params">(pathToAppend)</span> -&gt;</span> <span class="hljs-keyword">if</span> pathToAppend <span class="hljs-keyword">then</span> path.join(@.toString(), pathToAppend) <span class="hljs-keyword">else</span> @.toString()</pre></div></div> </li> <li id="section-3"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-3">&#182;</a> </div> <p>@.<strong>file_Dir_Name</strong></p> <p>twin methods: file_Parent_Folder, parent_Folder</p> </div> <div class="content"><div class='highlight'><pre><span class="hljs-attribute">String</span>::file_Dir_Name = <span class="hljs-function"><span class="hljs-params">()</span> -&gt;</span> path.dirname @ <span class="hljs-attribute">String</span>::file_Parent_Folder = <span class="hljs-attribute">String</span>::file_Dir_Name <span class="hljs-attribute">String</span>::parent_Folder = <span class="hljs-attribute">String</span>::file_Dir_Name</pre></div></div> </li> <li id="section-4"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-4">&#182;</a> </div> <p>@.<strong>file_Extension</strong></p> </div> <div class="content"><div class='highlight'><pre><span class="hljs-attribute">String</span>::file_Extension = <span class="hljs-function"><span class="hljs-params">()</span> -&gt;</span> path.extname(@.toString())</pre></div></div> </li> <li id="section-5"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-5">&#182;</a> </div> <p>@.<strong>file_Name</strong></p> </div> <div class="content"><div class='highlight'><pre><span class="hljs-attribute">String</span>::file_Name = <span class="hljs-function"><span class="hljs-params">()</span> -&gt;</span> path.basename @.toString()</pre></div></div> </li> <li id="section-6"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-6">&#182;</a> </div> <p>@.<strong>file_Names</strong></p> </div> <div class="content"><div class='highlight'><pre><span class="hljs-attribute">Array</span>::file_Names = <span class="hljs-function"><span class="hljs-params">()</span> -&gt;</span> file.file_Name() <span class="hljs-keyword">for</span> file <span class="hljs-keyword">in</span> @</pre></div></div> </li> <li id="section-7"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-7">&#182;</a> </div> <p>@.<strong>append_To_Process_Cwd_Path</strong></p> </div> <div class="content"><div class='highlight'><pre><span class="hljs-attribute">String</span>::append_To_Process_Cwd_Path = <span class="hljs-function"><span class="hljs-params">()</span> -&gt;</span> process.cwd().path_Combine(@.toString())</pre></div></div> </li> <li id="section-8"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-8">&#182;</a> </div> <p>@.<strong>file_Name_Without_Extension</strong></p> </div> <div class="content"><div class='highlight'><pre><span class="hljs-attribute">String</span>::file_Name_Without_Extension = <span class="hljs-function"><span class="hljs-params">()</span> -&gt;</span> path.basename @.toString() .replace(@.toString().file_Extension(), <span class="hljs-string">""</span>)</pre></div></div> </li> <li id="section-9"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-9">&#182;</a> </div> <p>@.<strong>file_Names_Without_Extension</strong></p> </div> <div class="content"><div class='highlight'><pre><span class="hljs-attribute">Array</span>:: file_Names_Without_Extension = <span class="hljs-function"><span class="hljs-params">()</span> -&gt;</span> file.file_Name_Without_Extension() <span class="hljs-keyword">for</span> file <span class="hljs-keyword">in</span> @</pre></div></div> </li> <li id="section-10"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-10">&#182;</a> </div> <p>@.<strong>folder_Name</strong></p> <p>Returns the name of the current folder (which is the right-most segment of a path)</p> <p>If you want the full path, use the <strong>parent_Folder</strong> method</p> </div> <div class="content"><div class='highlight'><pre><span class="hljs-attribute">String</span>::folder_Name = <span class="hljs-function"><span class="hljs-params">()</span>-&gt;</span> @.valueOf().file_Name()</pre></div></div> </li> <li id="section-11"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-11">&#182;</a> </div> <hr> </div> </li> <li id="section-12"> <div class="annotation"> <div class="pilwrap "> <a class="pilcrow" href="#section-12">&#182;</a> </div> <p>back to <a href="index.html">index</a></p> </div> </li> </ul> </div> </body> </html>