easyappointments/rsc/scripts/jsdoc/docs/env.html

441 lines
5.9 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Namespace: env</title>
<script src="scripts/prettify/prettify.js"> </script>
<script src="scripts/prettify/lang-css.js"> </script>
<!--[if lt IE 9]>
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
<![endif]-->
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>
<body>
<div id="main">
<h1 class="page-title">Namespace: env</h1>
<section>
<header>
<h2>
env
</h2>
</header>
<article>
<div class="container-overview">
<div class="description">Data representing the environment in which this app is running.</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="jsdoc.js.html">jsdoc.js</a>, <a href="jsdoc.js.html#line8">line 8</a>
</li></ul></dd>
</dl>
</div>
<h3 class="subsection-title">Members</h3>
<dl>
<dt>
<h4 class="name" id="args"><span class="type-signature">&lt;static> </span>args<span class="type-signature"> :Array</span></h4>
</dt>
<dd>
<div class="description">
The command-line arguments passed into JSDoc.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Array</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="jsdoc.js.html">jsdoc.js</a>, <a href="jsdoc.js.html#line35">line 35</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="conf"><span class="type-signature">&lt;static> </span>conf<span class="type-signature"> :Object</span></h4>
</dt>
<dd>
<div class="description">
The parsed JSON data from the configuration file.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="jsdoc.js.html">jsdoc.js</a>, <a href="jsdoc.js.html#line43">line 43</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="opts"><span class="type-signature">&lt;static> </span>opts<span class="type-signature"> :Object</span></h4>
</dt>
<dd>
<div class="description">
The command-line arguments, parsed into a key/value hash.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="jsdoc.js.html">jsdoc.js</a>, <a href="jsdoc.js.html#line62">line 62</a>
</li></ul></dd>
</dl>
<h5>Example</h5>
<pre class="prettyprint"><code> if (env.opts.help) { console.log('Helpful message.'); }</code></pre>
</dd>
<dt>
<h4 class="name" id="run"><span class="type-signature">&lt;static> </span>run<span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
Running start and finish times.
</div>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="jsdoc.js.html">jsdoc.js</a>, <a href="jsdoc.js.html#line24">line 24</a>
</li></ul></dd>
</dl>
</dd>
<dt>
<h4 class="name" id="version"><span class="type-signature">&lt;static> </span>version<span class="type-signature"> :Object</span></h4>
</dt>
<dd>
<div class="description">
The JSDoc version number and revision date.
</div>
<h5>Type:</h5>
<ul>
<li>
<span class="param-type">Object</span>
</li>
</ul>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="jsdoc.js.html">jsdoc.js</a>, <a href="jsdoc.js.html#line70">line 70</a>
</li></ul></dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Index</a></h2><h3>Namespaces</h3><ul><li><a href="app.html">app</a></li><li><a href="env.html">env</a></li></ul><h3>Global</h3><ul><li><a href="global.html#main">main</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.2.0-dev</a> on Mon May 20 2013 17:20:54 GMT+0300 (EEST)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>