yuidoc-asp

<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>Utils - yuidoc-root</title> <link rel="stylesheet" href="http://yui.yahooapis.com/3.9.1/build/cssgrids/cssgrids-min.css"> <link rel="stylesheet" href="../assets/vendor/prettify/prettify-min.css"> <link rel="stylesheet" href="../assets/css/main.css" id="site_styles"> <link rel="icon" href="../assets/favicon.ico"> <script src="http://yui.yahooapis.com/combo?3.9.1/build/yui/yui-min.js"></script> </head> <body class="yui3-skin-sam"> <div id="doc"> <div id="hd" class="yui3-g header"> <div class="yui3-u-3-4"> <h1><img src="../assets/css/logo.png" title="yuidoc-root" width="117" height="52"></h1> </div> <div class="yui3-u-1-4 version"> <em>API Docs for: 0.6.0</em> </div> </div> <div id="bd" class="yui3-g"> <div class="yui3-u-1-4"> <div id="docs-sidebar" class="sidebar apidocs"> <div id="api-list"> <h2 class="off-left">APIs</h2> <div id="api-tabview" class="tabview"> <ul class="tabs"> <li><a href="#api-classes">Classes</a></li> <li><a href="#api-modules">Modules</a></li> </ul> <div id="api-tabview-filter"> <input type="search" id="api-filter" placeholder="Type to filter APIs"> </div> <div id="api-tabview-panel"> <ul id="api-classes" class="apis classes"> <li><a href="../classes/CLI.html">CLI</a></li> <li><a href="../classes/DocBuilder.html">DocBuilder</a></li> <li><a href="../classes/DocParser.html">DocParser</a></li> <li><a href="../classes/DocView.html">DocView</a></li> <li><a href="../classes/Files.html">Files</a></li> <li><a href="../classes/Help.html">Help</a></li> <li><a href="../classes/Main.html">Main</a></li> <li><a href="../classes/Options.html">Options</a></li> <li><a href="../classes/Server.html">Server</a></li> <li><a href="../classes/Utils.html">Utils</a></li> <li><a href="../classes/YUIDoc.html">YUIDoc</a></li> </ul> <ul id="api-modules" class="apis modules"> <li><a href="../modules/yuidoc.html">yuidoc</a></li> </ul> </div> </div> </div> </div> </div> <div class="yui3-u-3-4"> <div id="api-options"> Show: <label for="api-show-inherited"> <input type="checkbox" id="api-show-inherited" checked> Inherited </label> <label for="api-show-protected"> <input type="checkbox" id="api-show-protected"> Protected </label> <label for="api-show-private"> <input type="checkbox" id="api-show-private"> Private </label> <label for="api-show-deprecated"> <input type="checkbox" id="api-show-deprecated"> Deprecated </label> </div> <div class="apidocs"> <div id="docs-main"> <div class="content"> <h1>Utils Class</h1> <div class="box meta"> <div class="foundat"> Defined in: <a href="../files/lib_utils.js.html#l11"><code>lib/utils.js:11</code></a> </div> Module: <a href="../modules/yuidoc.html">yuidoc</a> </div> <div class="box intro"> <p>Utilities Class</p> </div> <div id="classdocs" class="tabview"> <ul class="api-class-tabs"> <li class="api-class-tab index"><a href="#index">Index</a></li> <li class="api-class-tab methods"><a href="#methods">Methods</a></li> </ul> <div> <div id="index" class="api-class-tabpanel index"> <h2 class="off-left">Item Index</h2> <div class="index-section methods"> <h3>Methods</h3> <ul class="index-list methods"> <li class="index-item method"> <a href="#method_escapeHTML">escapeHTML</a> </li> <li class="index-item method"> <a href="#method_fixType">fixType</a> </li> <li class="index-item method"> <a href="#method_getDirs">getDirs</a> </li> <li class="index-item method"> <a href="#method_getLayouts">getLayouts</a> </li> <li class="index-item method"> <a href="#method_getPage">getPage</a> </li> <li class="index-item method"> <a href="#method_getPages">getPages</a> </li> <li class="index-item method"> <a href="#method_getPartials">getPartials</a> </li> <li class="index-item method"> <a href="#method_getProjectData">getProjectData</a> </li> <li class="index-item method"> <a href="#method_prepare">prepare</a> </li> <li class="index-item method private"> <a href="#method_unindent">unindent</a> </li> <li class="index-item method"> <a href="#method_validatePaths">validatePaths</a> </li> <li class="index-item method"> <a href="#method_webpath">webpath</a> </li> </ul> </div> </div> <div id="methods" class="api-class-tabpanel"> <h2 class="off-left">Methods</h2> <div id="method_escapeHTML" class="method item"> <h3 class="name"><code>escapeHTML</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>html</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> </span> <div class="meta"> <p> Defined in <a href="../files/lib_utils.js.html#l31"><code>lib/utils.js:31</code></a> </p> </div> <div class="description"> <p>Escapes HTML characters in <em>html</em>.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">html</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> <div class="param-description"> <p>String to escape.</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: <p>Escaped string.</p> </div> </div> </div> <div id="method_fixType" class="method item"> <h3 class="name"><code>fixType</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>t</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> </span> <div class="meta"> <p> Defined in <a href="../files/lib_utils.js.html#l454"><code>lib/utils.js:454</code></a> </p> </div> <div class="description"> <p>Takes a type string and converts it to a "First letter upper cased" type. e.g. <code>(string -> String, object -> Object)</code></p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">t</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> <div class="param-description"> <p>The type string to convert</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: <p>The fixed string</p> </div> </div> </div> <div id="method_getDirs" class="method item"> <h3 class="name"><code>getDirs</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>dir</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external external" target="_blank">Array</a></span> </span> <div class="meta"> <p> Defined in <a href="../files/lib_utils.js.html#l340"><code>lib/utils.js:340</code></a> </p> </div> <div class="description"> <p>Walks the tree from this dir and returns all the subdirs</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">dir</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> <div class="param-description"> <p>The dir to begin at</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external external" target="_blank">Array</a></span>: <p>The array of directories..</p> </div> </div> </div> <div id="method_getLayouts" class="method item"> <h3 class="name"><code>getLayouts</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>dir</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span> </span> <div class="meta"> <p> Defined in <a href="../files/lib_utils.js.html#l65"><code>lib/utils.js:65</code></a> </p> </div> <div class="description"> <p>Like <code>getPages()</code>, but returns only the files under the <code>layout/</code> subdirectory of the specified <em>dir</em>.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">dir</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> <div class="param-description"> <p>Directory path.</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>: <p>Mapping of layout names to layout content.</p> </div> </div> </div> <div id="method_getPage" class="method item"> <h3 class="name"><code>getPage</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>pagePath</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | Null</span> </span> <div class="meta"> <p> Defined in <a href="../files/lib_utils.js.html#l78"><code>lib/utils.js:78</code></a> </p> </div> <div class="description"> <p>Loads and returns the content of the specified page file.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">pagePath</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> <div class="param-description"> <p>Path to a single <code>.handlebars</code> page.</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a> | Null</span>: <p>Page content, or <code>null</code> if not found.</p> </div> </div> </div> <div id="method_getPages" class="method item"> <h3 class="name"><code>getPages</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>dir</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span> </span> <div class="meta"> <p> Defined in <a href="../files/lib_utils.js.html#l93"><code>lib/utils.js:93</code></a> </p> </div> <div class="description"> <p>Loads pages (files with a <code>.handlebars</code> extension) in the specified directory and returns an object containing a mapping of page names (the part of the filename) preceding the <code>.handlebars</code> extension) to page content.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">dir</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> <div class="param-description"> <p>Directory path.</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>: <p>Mapping of page names to page content.</p> </div> </div> </div> <div id="method_getPartials" class="method item"> <h3 class="name"><code>getPartials</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>dir</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span> </span> <div class="meta"> <p> Defined in <a href="../files/lib_utils.js.html#l126"><code>lib/utils.js:126</code></a> </p> </div> <div class="description"> <p>Like <code>getPages()</code>, but returns only the files under the <code>partial/</code> subdirectory of the specified <em>dir</em>.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">dir</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> <div class="param-description"> <p>Directory path.</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span>: <p>Mapping of partial names to partial content.</p> </div> </div> </div> <div id="method_getProjectData" class="method item"> <h3 class="name"><code>getProjectData</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code class="optional">[dir=process.cwd()]</code> </li> </ul><span class="paren">)</span> </div> <div class="meta"> <p> Defined in <a href="../files/lib_utils.js.html#l226"><code>lib/utils.js:226</code></a> </p> </div> <div class="description"> <p>Walk the directory tree to locate the yuidoc.json file.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name optional">[dir=process.cwd()]</code> <span class="type"><a href="http://yuilibrary.com/yui/docs/api/classes/Path.html" class="crosslink external" target="_blank">Path</a></span> <span class="flag optional" title="This parameter is optional.">optional</span> <div class="param-description"> <p>The directory to start from</p> </div> </li> </ul> </div> </div> <div id="method_prepare" class="method item"> <h3 class="name"><code>prepare</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>inDir</code> </li> <li class="arg"> <code>options</code> </li> <li class="arg"> <code>callback</code> </li> </ul><span class="paren">)</span> </div> <div class="meta"> <p> Defined in <a href="../files/lib_utils.js.html#l140"><code>lib/utils.js:140</code></a> </p> </div> <div class="description"> <p>Mix/merge/munge data into the template.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">inDir</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> <div class="param-description"> <p>The starting directory</p> </div> </li> <li class="param"> <code class="param-name">options</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span> <div class="param-description"> <p>The <code>options</code> for the meta data.</p> </div> </li> <li class="param"> <code class="param-name">callback</code> <span class="type">Callback</span> <div class="param-description"> <p>The callback to excecute when complete</p> </div> <ul class="params-list"> <li class="param"> <code class="param-name">err</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Error" class="crosslink external" target="_blank">Error</a></span> <div class="param-description"> </div> </li> <li class="param"> <code class="param-name">options</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Object" class="crosslink external external" target="_blank">Object</a></span> <div class="param-description"> <p>Merged options.</p> </div> </li> </ul> </li> </ul> </div> </div> <div id="method_unindent" class="method item private"> <h3 class="name"><code>unindent</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>content</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> </span> <span class="flag private">private</span> <div class="meta"> <p> Defined in <a href="../files/lib_utils.js.html#l44"><code>lib/utils.js:44</code></a> </p> </div> <div class="description"> <p>Normalizes the initial indentation of the given <em>content</em> so that the first line is unindented, and all other lines are unindented to the same degree as the first line. So if the first line has four spaces at the beginning, then all lines will be unindented four spaces.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">content</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> <div class="param-description"> <p>Text to unindent.</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: <p>Unindented text.</p> </div> </div> </div> <div id="method_validatePaths" class="method item"> <h3 class="name"><code>validatePaths</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>paths</code> </li> <li class="arg"> <code class="optional">[ignore=false]</code> </li> </ul><span class="paren">)</span> </div> <div class="meta"> <p> Defined in <a href="../files/lib_utils.js.html#l366"><code>lib/utils.js:366</code></a> </p> </div> <div class="description"> <p>Make sure all the paths passed are directories and that they are not in the ignore list.</p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">paths</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external external" target="_blank">Array</a></span> <div class="param-description"> <p>The array of paths to validate</p> </div> </li> <li class="param"> <code class="param-name optional">[ignore=false]</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> <span class="flag optional" title="This parameter is optional.">optional</span> <div class="param-description"> <p>A string to call <code>.indexOf</code> on a path to determine if it should be ignored</p> </div> </li> </ul> </div> </div> <div id="method_webpath" class="method item"> <h3 class="name"><code>webpath</code></h3> <div class="args"> <span class="paren">(</span><ul class="args-list inline commas"> <li class="arg"> <code>url</code> </li> </ul><span class="paren">)</span> </div> <span class="returns-inline"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span> </span> <div class="meta"> <p> Defined in <a href="../files/lib_utils.js.html#l476"><code>lib/utils.js:476</code></a> </p> </div> <div class="description"> <p>Produces a normalized web path by joining all the parts and normalizing the filesystem-like path into web compatible url. Supports relative and absolute paths. Courtesy of <a href="https://github.com/yahoo/mojito/">Mojito's utils</a></p> </div> <div class="params"> <h4>Parameters:</h4> <ul class="params-list"> <li class="param"> <code class="param-name">url</code> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Array" class="crosslink external external" target="_blank">Array</a> | <a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String*</a></span> <div class="param-description"> <p>the list of parts to be joined and normalized</p> </div> </li> </ul> </div> <div class="returns"> <h4>Returns:</h4> <div class="returns-description"> <span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/String" class="crosslink external" target="_blank">String</a></span>: <p>The joined and normalized url</p> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> </div> <script src="../assets/vendor/prettify/prettify-min.js"></script> <script>prettyPrint();</script> <script src="../assets/js/yui-prettify.js"></script> <script src="../assets/../api.js"></script> <script src="../assets/js/api-filter.js"></script> <script src="../assets/js/api-list.js"></script> <script src="../assets/js/api-search.js"></script> <script src="../assets/js/apidocs.js"></script> </body> </html>