← Back to branch summary

~yolanda.robla/ubuntu/trusty/nodejs/add_distribution

« back to all changes in this revision

Viewing changes to doc/api/api/documentation.html

  • Committer: Package Import Robot
  • Author(s): Jérémy Lal
  • Date: 2013-08-14 00:16:46 UTC
  • mfrom: (7.1.40 sid)
  • Revision ID: package-import@ubuntu.com-20130814001646-bzlysfh8sd6mukbo
Tags: 0.10.15~dfsg1-4
* Update 2005 patch, adding a handful of tests that can fail on
  slow platforms.
* Add 1004 patch to fix test failures when writing NaN to buffer
  on mipsel.

Show diffs side-by-side

added added

removed removed

Lines of Context:
doc/api/api/documentation.html
1
 
<!doctype html>
2
 
<html lang="en">
3
 
<head>
4
 
  <meta charset="utf-8">
5
 
  <title>About this Documentation Node.js v0.6.18 Manual &amp; Documentation</title>
6
 
  <link rel="stylesheet" href="assets/style.css">
7
 
  <link rel="stylesheet" href="assets/sh.css">
8
 
  <link rel="canonical" href="http://nodejs.org/api/documentation.html">
9
 
</head>
10
 
<body class="alt apidoc" id="api-section-documentation">
11
 
    <div id="intro" class="interior">
12
 
        <a href="/" title="Go back to the home page">
13
 
            <img id="logo" src="http://nodejs.org/images/logo-light.png" alt="node.js">
14
 
        </a>
15
 
    </div>
16
 
    <div id="content" class="clearfix">
17
 
        <div id="column2" class="interior">
18
 
            <ul>
19
 
                <li><a href="/" class="home">Home</a></li>
20
 
                <li><a href="/#download" class="download">Download</a></li>
21
 
                <li><a href="/about/" class="about">About</a></li>
22
 
                <li><a href="http://search.npmjs.org/" class="npm">npm Registry</a></li>
23
 
                <li><a href="http://nodejs.org/api/" class="docs current">Docs</a></li>
24
 
                <li><a href="http://blog.nodejs.org" class="blog">Blog</a></li>
25
 
                <li><a href="/community/" class="community">Community</a></li>
26
 
                <li><a href="/logos/" class="logos">Logos</a></li>
27
 
                <li><a href="http://jobs.nodejs.org/" class="jobs">Jobs</a></li>
28
 
            </ul>
29
 
            <p class="twitter"><a href="http://twitter.com/nodejs">@nodejs</a></p>
30
 
        </div>
31
 
 
32
 
        <div id="column1" class="interior">
33
 
          <header>
34
 
            <h1>Node.js v0.6.18 Manual &amp; Documentation</h1>
35
 
            <div id="gtoc">
36
 
              <p>
37
 
                <a href="index.html" name="toc">Index</a> |
38
 
                <a href="all.html">View on single page</a> |
39
 
                <a href="documentation.json">View as JSON</a>
40
 
              </p>
41
 
            </div>
42
 
            <hr>
43
 
          </header>
44
 
 
45
 
          <div id="toc">
46
 
            <h2>Table of Contents</h2>
47
 
            <ul>
48
 
<li><a href="#documentation_about_this_documentation">About this Documentation</a><ul>
49
 
<li><a href="#documentation_stability_index">Stability Index</a></li>
50
 
<li><a href="#documentation_json_output">JSON Output</a></li>
51
 
</ul>
52
 
</li>
53
 
</ul>
54
 
 
55
 
          </div>
56
 
 
57
 
          <div id="apicontent">
58
 
            <h1>About this Documentation<span><a class="mark" href="#documentation_about_this_documentation" id="documentation_about_this_documentation">#</a></span></h1>
59
 
<!-- type=misc -->
60
 
 
61
 
<p>The goal of this documentation is to comprehensively explain the Node.js
62
 
API, both from a reference as well as a conceptual point of view.  Each
63
 
section describes a built-in module or high-level concept.
64
 
 
65
 
</p>
66
 
<p>Where appropriate, property types, method arguments, and the arguments
67
 
provided to event handlers are detailed in a list underneath the topic
68
 
heading.
69
 
 
70
 
</p>
71
 
<p>Every <code>.html</code> document has a corresponding <code>.json</code> document presenting
72
 
the same information in a structured manner.  This feature is
73
 
experimental, and added for the benefit of IDEs and other utilities that
74
 
wish to do programmatic things with the documentation.
75
 
 
76
 
</p>
77
 
<p>Every <code>.html</code> and <code>.json</code> file is generated based on the corresponding
78
 
<code>.markdown</code> file in the <code>doc/api/</code> folder in node&apos;s source tree.  The
79
 
documentation is generated using the <code>tools/doc/generate.js</code> program.
80
 
The HTML template is located at <code>doc/template.html</code>.
81
 
 
82
 
</p>
83
 
<h2>Stability Index<span><a class="mark" href="#documentation_stability_index" id="documentation_stability_index">#</a></span></h2>
84
 
<!--type=misc-->
85
 
 
86
 
<p>Throughout the documentation, you will see indications of a section&apos;s
87
 
stability.  The Node.js API is still somewhat changing, and as it
88
 
matures, certain parts are more reliable than others.  Some are so
89
 
proven, and so relied upon, that they are unlikely to ever change at
90
 
all.  Others are brand new and experimental, or known to be hazardous
91
 
and in the process of being redesigned.
92
 
 
93
 
</p>
94
 
<p>The notices look like this:
95
 
 
96
 
</p>
97
 
<pre><code>Stability: 1 Experimental</code></pre>
98
 
<p>The stability indices are as follows:
99
 
 
100
 
</p>
101
 
<ul>
102
 
<li><strong>0 - Deprecated</strong>  This feature is known to be problematic, and changes are
103
 
planned.  Do not rely on it.  Use of the feature may cause warnings.  Backwards
104
 
compatibility should not be expected.</li>
105
 
</ul>
106
 
<ul>
107
 
<li><strong>1 - Experimental</strong>  This feature was introduced recently, and may change
108
 
or be removed in future versions.  Please try it out and provide feedback.
109
 
If it addresses a use-case that is important to you, tell the node core team.</li>
110
 
</ul>
111
 
<ul>
112
 
<li><strong>2 - Unstable</strong>  The API is in the process of settling, but has not yet had
113
 
sufficient real-world testing to be considered stable. Backwards-compatibility
114
 
will be maintained if reasonable.</li>
115
 
</ul>
116
 
<ul>
117
 
<li><strong>3 - Stable</strong>  The API has proven satisfactory, but cleanup in the underlying
118
 
code may cause minor changes.  Backwards-compatibility is guaranteed.</li>
119
 
</ul>
120
 
<ul>
121
 
<li><strong>4 - API Frozen</strong>  This API has been tested extensively in production and is
122
 
unlikely to ever have to change.</li>
123
 
</ul>
124
 
<ul>
125
 
<li><strong>5 - Locked</strong>  Unless serious bugs are found, this code will not ever
126
 
change.  Please do not suggest changes in this area; they will be refused.</li>
127
 
</ul>
128
 
<h2>JSON Output<span><a class="mark" href="#documentation_json_output" id="documentation_json_output">#</a></span></h2>
129
 
<pre><code>Stability: 1 - Experimental</code></pre>
130
 
<p>Every HTML file in the markdown has a corresponding JSON file with the
131
 
same data.
132
 
 
133
 
</p>
134
 
<p>This feature is new as of node v0.6.12.  It is experimental.
135
 
</p>
136
 
 
137
 
          </div>
138
 
        </div>
139
 
    </div>
140
 
    <div id="footer">
141
 
        <ul class="clearfix">
142
 
            <li><a href="/">Node.js</a></li>
143
 
            <li><a href="/#download">Download</a></li>
144
 
            <li><a href="/about/">About</a></li>
145
 
            <li><a href="http://search.npmjs.org/">npm Registry</a></li>
146
 
            <li><a href="http://nodejs.org/api/">Docs</a></li>
147
 
            <li><a href="http://blog.nodejs.org">Blog</a></li>
148
 
            <li><a href="/community/">Community</a></li>
149
 
            <li><a href="/logos/">Logos</a></li>
150
 
            <li><a href="http://jobs.nodejs.org/">Jobs</a></li>
151
 
            <li><a href="http://twitter.com/nodejs" class="twitter">@nodejs</a></li>
152
 
        </ul>
153
 
 
154
 
        <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.6.18/LICENSE">license</a>.</p>
155
 
    </div>
156
 
 
157
 
  <script src="../sh_main.js"></script>
158
 
  <script src="../sh_javascript.min.js"></script>
159
 
  <script>highlight(undefined, undefined, 'pre');</script>
160
 
  <script>
161
 
    var gaJsHost = (("https:" == document.location.protocol) ?
162
 
    "https://ssl." : "http://www.");
163
 
    document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
164
 
  </script>
165
 
  <script>
166
 
    try {
167
 
      var pageTracker = _gat._getTracker("UA-10874194-2");
168
 
      pageTracker._trackPageview();
169
 
      } catch(err) {}</script>
170
 
</body>
171
 
</html>
172