| <!doctype html> |
| <html lang="en"> |
| <head> |
| <meta charset="utf-8"> |
| <title>About this Documentation Node.js v0.10.24 Manual & Documentation</title> |
| <link rel="stylesheet" href="assets/style.css"> |
| <link rel="stylesheet" href="assets/sh.css"> |
| <link rel="canonical" href="http://nodejs.org/api/documentation.html"> |
| </head> |
| <body class="alt apidoc" id="api-section-documentation"> |
| <div id="intro" class="interior"> |
| <a href="/" title="Go back to the home page"> |
| <img id="logo" src="http://nodejs.org/images/logo-light.png" alt="node.js"> |
| </a> |
| </div> |
| <div id="content" class="clearfix"> |
| <div id="column2" class="interior"> |
| <ul> |
| <li><a href="/" class="home">Home</a></li> |
| <li><a href="/download/" class="download">Download</a></li> |
| <li><a href="/about/" class="about">About</a></li> |
| <li><a href="http://npmjs.org/" class="npm">npm Registry</a></li> |
| <li><a href="http://nodejs.org/api/" class="docs current">Docs</a></li> |
| <li><a href="http://blog.nodejs.org" class="blog">Blog</a></li> |
| <li><a href="/community/" class="community">Community</a></li> |
| <li><a href="/logos/" class="logos">Logos</a></li> |
| <li><a href="http://jobs.nodejs.org/" class="jobs">Jobs</a></li> |
| </ul> |
| <p class="twitter"><a href="http://twitter.com/nodejs">@nodejs</a></p> |
| </div> |
| |
| <div id="column1" class="interior"> |
| <header> |
| <h1>Node.js v0.10.24 Manual & Documentation</h1> |
| <div id="gtoc"> |
| <p> |
| <a href="index.html" name="toc">Index</a> | |
| <a href="all.html">View on single page</a> | |
| <a href="documentation.json">View as JSON</a> |
| </p> |
| </div> |
| <hr> |
| </header> |
| |
| <div id="toc"> |
| <h2>Table of Contents</h2> |
| <ul> |
| <li><a href="#documentation_about_this_documentation">About this Documentation</a><ul> |
| <li><a href="#documentation_stability_index">Stability Index</a></li> |
| <li><a href="#documentation_json_output">JSON Output</a></li> |
| </ul> |
| </li> |
| </ul> |
| |
| </div> |
| |
| <div id="apicontent"> |
| <h1>About this Documentation<span><a class="mark" href="#documentation_about_this_documentation" id="documentation_about_this_documentation">#</a></span></h1> |
| <!-- type=misc --> |
| |
| <p>The goal of this documentation is to comprehensively explain the Node.js |
| API, both from a reference as well as a conceptual point of view. Each |
| section describes a built-in module or high-level concept. |
| |
| </p> |
| <p>Where appropriate, property types, method arguments, and the arguments |
| provided to event handlers are detailed in a list underneath the topic |
| heading. |
| |
| </p> |
| <p>Every <code>.html</code> document has a corresponding <code>.json</code> document presenting |
| the same information in a structured manner. This feature is |
| experimental, and added for the benefit of IDEs and other utilities that |
| wish to do programmatic things with the documentation. |
| |
| </p> |
| <p>Every <code>.html</code> and <code>.json</code> file is generated based on the corresponding |
| <code>.markdown</code> file in the <code>doc/api/</code> folder in node's source tree. The |
| documentation is generated using the <code>tools/doc/generate.js</code> program. |
| The HTML template is located at <code>doc/template.html</code>. |
| |
| </p> |
| <h2>Stability Index<span><a class="mark" href="#documentation_stability_index" id="documentation_stability_index">#</a></span></h2> |
| <!--type=misc--> |
| |
| <p>Throughout the documentation, you will see indications of a section's |
| stability. The Node.js API is still somewhat changing, and as it |
| matures, certain parts are more reliable than others. Some are so |
| proven, and so relied upon, that they are unlikely to ever change at |
| all. Others are brand new and experimental, or known to be hazardous |
| and in the process of being redesigned. |
| |
| </p> |
| <p>The stability indices are as follows: |
| |
| </p> |
| <pre class="api_stability_0">Stability: 0 - Deprecated |
| This feature is known to be problematic, and changes are |
| planned. Do not rely on it. Use of the feature may cause warnings. Backwards |
| compatibility should not be expected.</pre><pre class="api_stability_1">Stability: 1 - Experimental |
| This feature was introduced recently, and may change |
| or be removed in future versions. Please try it out and provide feedback. |
| If it addresses a use-case that is important to you, tell the node core team.</pre><pre class="api_stability_2">Stability: 2 - Unstable |
| The API is in the process of settling, but has not yet had |
| sufficient real-world testing to be considered stable. Backwards-compatibility |
| will be maintained if reasonable.</pre><pre class="api_stability_3">Stability: 3 - Stable |
| The API has proven satisfactory, but cleanup in the underlying |
| code may cause minor changes. Backwards-compatibility is guaranteed.</pre><pre class="api_stability_4">Stability: 4 - API Frozen |
| This API has been tested extensively in production and is |
| unlikely to ever have to change.</pre><pre class="api_stability_5">Stability: 5 - Locked |
| Unless serious bugs are found, this code will not ever |
| change. Please do not suggest changes in this area; they will be refused.</pre><h2>JSON Output<span><a class="mark" href="#documentation_json_output" id="documentation_json_output">#</a></span></h2> |
| <pre class="api_stability_1">Stability: 1 - Experimental</pre><p>Every HTML file in the markdown has a corresponding JSON file with the |
| same data. |
| |
| </p> |
| <p>This feature is new as of node v0.6.12. It is experimental. |
| </p> |
| |
| </div> |
| </div> |
| </div> |
| <div id="footer"> |
| <a href="http://joyent.com" class="joyent-logo">Joyent</a> |
| <ul class="clearfix"> |
| <li><a href="/">Node.js</a></li> |
| <li><a href="/download/">Download</a></li> |
| <li><a href="/about/">About</a></li> |
| <li><a href="http://npmjs.org/">npm Registry</a></li> |
| <li><a href="http://nodejs.org/api/">Docs</a></li> |
| <li><a href="http://blog.nodejs.org">Blog</a></li> |
| <li><a href="/community/">Community</a></li> |
| <li><a href="/logos/">Logos</a></li> |
| <li><a href="http://jobs.nodejs.org/">Jobs</a></li> |
| <li><a href="http://twitter.com/nodejs" class="twitter">@nodejs</a></li> |
| </ul> |
| |
| <p>Copyright <a href="http://joyent.com/">Joyent, Inc</a>, Node.js is a <a href="/trademark-policy.pdf">trademark</a> of Joyent, Inc. View <a href="https://raw.github.com/joyent/node/v0.10.24/LICENSE">license</a>.</p> |
| </div> |
| |
| <script src="../sh_main.js"></script> |
| <script src="../sh_javascript.min.js"></script> |
| <script>highlight(undefined, undefined, 'pre');</script> |
| <script> |
| window._gaq = [['_setAccount', 'UA-10874194-2'], ['_trackPageview']]; |
| (function(d, t) { |
| var g = d.createElement(t), |
| s = d.getElementsByTagName(t)[0]; |
| g.src = '//www.google-analytics.com/ga.js'; |
| s.parentNode.insertBefore(g, s); |
| }(document, 'script')); |
| </script> |
| </body> |
| </html> |
| |