Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Fetching contributors…

Cannot retrieve contributors at this time

1082 lines (446 sloc) 23.27 kB
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>Server - YUIDoc</title>
<link rel="stylesheet" href="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;3.8.0&#x2F;build&#x2F;cssgrids&#x2F;cssgrids-min.css">
<link rel="stylesheet" href="..&#x2F;assets/vendor/prettify/prettify-min.css">
<link rel="stylesheet" href="..&#x2F;assets/css/main.css" id="site_styles">
<link rel="shortcut icon" type="image/png" href="..&#x2F;assets/favicon.png">
<script src="http:&#x2F;&#x2F;yui.yahooapis.com&#x2F;combo?3.8.0&#x2F;build&#x2F;yui&#x2F;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="http:&#x2F;&#x2F;yuilibrary.com&#x2F;img&#x2F;yui-logo.png" title="YUIDoc"></h1>
</div>
<div class="yui3-u-1-4 version">
<em>API Docs for: 0.3.36</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="..&#x2F;classes/CLI.html">CLI</a></li>
<li><a href="..&#x2F;classes/DocBuilder.html">DocBuilder</a></li>
<li><a href="..&#x2F;classes/DocParser.html">DocParser</a></li>
<li><a href="..&#x2F;classes/DocView.html">DocView</a></li>
<li><a href="..&#x2F;classes/Files.html">Files</a></li>
<li><a href="..&#x2F;classes/Help.html">Help</a></li>
<li><a href="..&#x2F;classes/Main.html">Main</a></li>
<li><a href="..&#x2F;classes/Options.html">Options</a></li>
<li><a href="..&#x2F;classes/Server.html">Server</a></li>
<li><a href="..&#x2F;classes/Utils.html">Utils</a></li>
<li><a href="..&#x2F;classes/YUIDoc.html">YUIDoc</a></li>
</ul>
<ul id="api-modules" class="apis modules">
<li><a href="..&#x2F;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>Server Class</h1>
<div class="box meta">
<div class="foundat">
Defined in: <a href="..&#x2F;files&#x2F;lib_server.js.html#l4"><code>lib&#x2F;server.js:4</code></a>
</div>
Module: <a href="../modules/yuidoc.html">yuidoc</a>
</div>
<div class="box intro">
<p>Provides the <code>--server</code> server option for YUIDoc</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>
<li class="api-class-tab properties"><a href="#properties">Properties</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_clazz">clazz</a>
</li>
<li class="index-item method">
<a href="#method_files">files</a>
</li>
<li class="index-item method">
<a href="#method_home">home</a>
</li>
<li class="index-item method">
<a href="#method_init">init</a>
</li>
<li class="index-item method">
<a href="#method_modules">modules</a>
</li>
<li class="index-item method">
<a href="#method_parse">parse</a>
</li>
<li class="index-item method">
<a href="#method_routes">routes</a>
</li>
<li class="index-item method">
<a href="#method_start">start</a>
</li>
</ul>
</div>
<div class="index-section properties">
<h3>Properties</h3>
<ul class="index-list properties">
<li class="index-item property private">
<a href="#property__externalData">_externalData</a>
</li>
</ul>
</div>
</div>
<div id="methods" class="api-class-tabpanel">
<h2 class="off-left">Methods</h2>
<div id="method_clazz" class="method item">
<h3 class="name"><code>clazz</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>req</code>
</li>
<li class="arg">
<code>res</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_server.js.html#l132"><code>lib&#x2F;server.js:132</code></a>
</p>
</div>
<div class="description">
<p><code>/classes</code> endpoint</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">req</code>
<span class="type">Request</span>
<div class="param-description">
<p>Express request object</p>
</div>
</li>
<li class="param">
<code class="param-name">res</code>
<span class="type">Response</span>
<div class="param-description">
<p>Express response object</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_files" class="method item">
<h3 class="name"><code>files</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>req</code>
</li>
<li class="arg">
<code>res</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_server.js.html#l106"><code>lib&#x2F;server.js:106</code></a>
</p>
</div>
<div class="description">
<p><code>/files</code> endpoint</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">req</code>
<span class="type">Request</span>
<div class="param-description">
<p>Express request object</p>
</div>
</li>
<li class="param">
<code class="param-name">res</code>
<span class="type">Response</span>
<div class="param-description">
<p>Express response object</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_home" class="method item">
<h3 class="name"><code>home</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>req</code>
</li>
<li class="arg">
<code>res</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_server.js.html#l164"><code>lib&#x2F;server.js:164</code></a>
</p>
</div>
<div class="description">
<p><code>/</code> endpoint</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">req</code>
<span class="type">Request</span>
<div class="param-description">
<p>Express request object</p>
</div>
</li>
<li class="param">
<code class="param-name">res</code>
<span class="type">Response</span>
<div class="param-description">
<p>Express response object</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_init" class="method item">
<h3 class="name"><code>init</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_server.js.html#l176"><code>lib&#x2F;server.js:176</code></a>
</p>
</div>
<div class="description">
<p>Creates the Express server and prep's YUI for serving</p>
</div>
</div>
<div id="method_modules" class="method item">
<h3 class="name"><code>modules</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>req</code>
</li>
<li class="arg">
<code>res</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_server.js.html#l148"><code>lib&#x2F;server.js:148</code></a>
</p>
</div>
<div class="description">
<p><code>/modules</code> endpoint</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">req</code>
<span class="type">Request</span>
<div class="param-description">
<p>Express request object</p>
</div>
</li>
<li class="param">
<code class="param-name">res</code>
<span class="type">Response</span>
<div class="param-description">
<p>Express response object</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_parse" class="method item">
<h3 class="name"><code>parse</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>req</code>
</li>
<li class="arg">
<code>res</code>
</li>
<li class="arg">
<code>next</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_server.js.html#l17"><code>lib&#x2F;server.js:17</code></a>
</p>
</div>
<div class="description">
<p>Middleware to parse the API docs per request</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<li class="param">
<code class="param-name">req</code>
<span class="type">Request</span>
<div class="param-description">
<p>Express request object</p>
</div>
</li>
<li class="param">
<code class="param-name">res</code>
<span class="type">Response</span>
<div class="param-description">
<p>Express response object</p>
</div>
</li>
<li class="param">
<code class="param-name">next</code>
<span class="type"><a href="https://developer.mozilla.org/en/JavaScript/Reference/Global_Objects/Function" class="crosslink external" target="_blank">Function</a></span>
<div class="param-description">
<p>Express next callback</p>
</div>
</li>
</ul>
</div>
</div>
<div id="method_routes" class="method item">
<h3 class="name"><code>routes</code></h3>
<span class="paren">()</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_server.js.html#l35"><code>lib&#x2F;server.js:35</code></a>
</p>
</div>
<div class="description">
<p>Create the routes used to serve YUIDoc files dynamically</p>
</div>
</div>
<div id="method_start" class="method item">
<h3 class="name"><code>start</code></h3>
<div class="args">
<span class="paren">(</span><ul class="args-list inline commas">
<li class="arg">
<code>options</code>
</li>
</ul><span class="paren">)</span>
</div>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_server.js.html#l194"><code>lib&#x2F;server.js:194</code></a>
</p>
</div>
<div class="description">
<p>Start the server with the supplied options.</p>
</div>
<div class="params">
<h4>Parameters:</h4>
<ul class="params-list">
<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>Server options</p>
</div>
</li>
</ul>
</div>
</div>
</div>
<div id="properties" class="api-class-tabpanel">
<h2 class="off-left">Properties</h2>
<div id="property__externalData" class="property item private">
<h3 class="name"><code>_externalData</code></h3>
<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 class="flag private">private</span>
<div class="meta">
<p>
Defined in
<a href="..&#x2F;files&#x2F;lib_server.js.html#l10"><code>lib&#x2F;server.js:10</code></a>
</p>
</div>
<div class="description">
<p>Cache for external mixed in data.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<script src="..&#x2F;assets/vendor/prettify/prettify-min.js"></script>
<script>prettyPrint();</script>
<script src="..&#x2F;assets/js/yui-prettify.js"></script>
<script src="..&#x2F;assets/../api.js"></script>
<script src="..&#x2F;assets/js/api-filter.js"></script>
<script src="..&#x2F;assets/js/api-list.js"></script>
<script src="..&#x2F;assets/js/api-search.js"></script>
<script src="..&#x2F;assets/js/apidocs.js"></script>
</body>
</html>
Jump to Line
Something went wrong with that request. Please try again.