← Back to branch summary

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

« back to all changes in this revision

Viewing changes to doc/api/api/os.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/os.html
1
 
<!doctype html>
2
 
<html lang="en">
3
 
<head>
4
 
  <meta charset="utf-8">
5
 
  <title>os 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/os.html">
9
 
</head>
10
 
<body class="alt apidoc" id="api-section-os">
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="os.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="#os_os">os</a><ul>
49
 
<li><a href="#os_os_hostname">os.hostname()</a></li>
50
 
<li><a href="#os_os_type">os.type()</a></li>
51
 
<li><a href="#os_os_platform">os.platform()</a></li>
52
 
<li><a href="#os_os_arch">os.arch()</a></li>
53
 
<li><a href="#os_os_release">os.release()</a></li>
54
 
<li><a href="#os_os_uptime">os.uptime()</a></li>
55
 
<li><a href="#os_os_loadavg">os.loadavg()</a></li>
56
 
<li><a href="#os_os_totalmem">os.totalmem()</a></li>
57
 
<li><a href="#os_os_freemem">os.freemem()</a></li>
58
 
<li><a href="#os_os_cpus">os.cpus()</a></li>
59
 
<li><a href="#os_os_networkinterfaces">os.networkInterfaces()</a></li>
60
 
</ul>
61
 
</li>
62
 
</ul>
63
 
 
64
 
          </div>
65
 
 
66
 
          <div id="apicontent">
67
 
            <h1>os<span><a class="mark" href="#os_os" id="os_os">#</a></span></h1>
68
 
<pre><code>Stability: 4 - API Frozen</code></pre>
69
 
<p>Provides a few basic operating-system related utility functions.
70
 
 
71
 
</p>
72
 
<p>Use <code>require(&apos;os&apos;)</code> to access this module.
73
 
 
74
 
</p>
75
 
<h2>os.hostname()<span><a class="mark" href="#os_os_hostname" id="os_os_hostname">#</a></span></h2>
76
 
<p>Returns the hostname of the operating system.
77
 
 
78
 
</p>
79
 
<h2>os.type()<span><a class="mark" href="#os_os_type" id="os_os_type">#</a></span></h2>
80
 
<p>Returns the operating system name.
81
 
 
82
 
</p>
83
 
<h2>os.platform()<span><a class="mark" href="#os_os_platform" id="os_os_platform">#</a></span></h2>
84
 
<p>Returns the operating system platform.
85
 
 
86
 
</p>
87
 
<h2>os.arch()<span><a class="mark" href="#os_os_arch" id="os_os_arch">#</a></span></h2>
88
 
<p>Returns the operating system CPU architecture.
89
 
 
90
 
</p>
91
 
<h2>os.release()<span><a class="mark" href="#os_os_release" id="os_os_release">#</a></span></h2>
92
 
<p>Returns the operating system release.
93
 
 
94
 
</p>
95
 
<h2>os.uptime()<span><a class="mark" href="#os_os_uptime" id="os_os_uptime">#</a></span></h2>
96
 
<p>Returns the system uptime in seconds.
97
 
 
98
 
</p>
99
 
<h2>os.loadavg()<span><a class="mark" href="#os_os_loadavg" id="os_os_loadavg">#</a></span></h2>
100
 
<p>Returns an array containing the 1, 5, and 15 minute load averages.
101
 
 
102
 
</p>
103
 
<h2>os.totalmem()<span><a class="mark" href="#os_os_totalmem" id="os_os_totalmem">#</a></span></h2>
104
 
<p>Returns the total amount of system memory in bytes.
105
 
 
106
 
</p>
107
 
<h2>os.freemem()<span><a class="mark" href="#os_os_freemem" id="os_os_freemem">#</a></span></h2>
108
 
<p>Returns the amount of free system memory in bytes.
109
 
 
110
 
</p>
111
 
<h2>os.cpus()<span><a class="mark" href="#os_os_cpus" id="os_os_cpus">#</a></span></h2>
112
 
<p>Returns an array of objects containing information about each CPU/core installed: model, speed (in MHz), and times (an object containing the number of CPU ticks spent in: user, nice, sys, idle, and irq).
113
 
 
114
 
</p>
115
 
<p>Example inspection of os.cpus:
116
 
 
117
 
</p>
118
 
<pre><code>[ { model: &apos;Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz&apos;,
119
 
    speed: 2926,
120
 
    times:
121
 
     { user: 252020,
122
 
       nice: 0,
123
 
       sys: 30340,
124
 
       idle: 1070356870,
125
 
       irq: 0 } },
126
 
  { model: &apos;Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz&apos;,
127
 
    speed: 2926,
128
 
    times:
129
 
     { user: 306960,
130
 
       nice: 0,
131
 
       sys: 26980,
132
 
       idle: 1071569080,
133
 
       irq: 0 } },
134
 
  { model: &apos;Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz&apos;,
135
 
    speed: 2926,
136
 
    times:
137
 
     { user: 248450,
138
 
       nice: 0,
139
 
       sys: 21750,
140
 
       idle: 1070919370,
141
 
       irq: 0 } },
142
 
  { model: &apos;Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz&apos;,
143
 
    speed: 2926,
144
 
    times:
145
 
     { user: 256880,
146
 
       nice: 0,
147
 
       sys: 19430,
148
 
       idle: 1070905480,
149
 
       irq: 20 } },
150
 
  { model: &apos;Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz&apos;,
151
 
    speed: 2926,
152
 
    times:
153
 
     { user: 511580,
154
 
       nice: 20,
155
 
       sys: 40900,
156
 
       idle: 1070842510,
157
 
       irq: 0 } },
158
 
  { model: &apos;Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz&apos;,
159
 
    speed: 2926,
160
 
    times:
161
 
     { user: 291660,
162
 
       nice: 0,
163
 
       sys: 34360,
164
 
       idle: 1070888000,
165
 
       irq: 10 } },
166
 
  { model: &apos;Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz&apos;,
167
 
    speed: 2926,
168
 
    times:
169
 
     { user: 308260,
170
 
       nice: 0,
171
 
       sys: 55410,
172
 
       idle: 1071129970,
173
 
       irq: 880 } },
174
 
  { model: &apos;Intel(R) Core(TM) i7 CPU         860  @ 2.80GHz&apos;,
175
 
    speed: 2926,
176
 
    times:
177
 
     { user: 266450,
178
 
       nice: 1480,
179
 
       sys: 34920,
180
 
       idle: 1072572010,
181
 
       irq: 30 } } ]</code></pre>
182
 
<h2>os.networkInterfaces()<span><a class="mark" href="#os_os_networkinterfaces" id="os_os_networkinterfaces">#</a></span></h2>
183
 
<p>Get a list of network interfaces:
184
 
 
185
 
</p>
186
 
<pre><code>{ lo0: 
187
 
   [ { address: &apos;::1&apos;, family: &apos;IPv6&apos;, internal: true },
188
 
     { address: &apos;fe80::1&apos;, family: &apos;IPv6&apos;, internal: true },
189
 
     { address: &apos;127.0.0.1&apos;, family: &apos;IPv4&apos;, internal: true } ],
190
 
  en1: 
191
 
   [ { address: &apos;fe80::cabc:c8ff:feef:f996&apos;, family: &apos;IPv6&apos;,
192
 
       internal: false },
193
 
     { address: &apos;10.0.1.123&apos;, family: &apos;IPv4&apos;, internal: false } ],
194
 
  vmnet1: [ { address: &apos;10.99.99.254&apos;, family: &apos;IPv4&apos;, internal: false } ],
195
 
  vmnet8: [ { address: &apos;10.88.88.1&apos;, family: &apos;IPv4&apos;, internal: false } ],
196
 
  ppp0: [ { address: &apos;10.2.0.231&apos;, family: &apos;IPv4&apos;, internal: false } ] }</code></pre>
197
 
 
198
 
          </div>
199
 
        </div>
200
 
    </div>
201
 
    <div id="footer">
202
 
        <ul class="clearfix">
203
 
            <li><a href="/">Node.js</a></li>
204
 
            <li><a href="/#download">Download</a></li>
205
 
            <li><a href="/about/">About</a></li>
206
 
            <li><a href="http://search.npmjs.org/">npm Registry</a></li>
207
 
            <li><a href="http://nodejs.org/api/">Docs</a></li>
208
 
            <li><a href="http://blog.nodejs.org">Blog</a></li>
209
 
            <li><a href="/community/">Community</a></li>
210
 
            <li><a href="/logos/">Logos</a></li>
211
 
            <li><a href="http://jobs.nodejs.org/">Jobs</a></li>
212
 
            <li><a href="http://twitter.com/nodejs" class="twitter">@nodejs</a></li>
213
 
        </ul>
214
 
 
215
 
        <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>
216
 
    </div>
217
 
 
218
 
  <script src="../sh_main.js"></script>
219
 
  <script src="../sh_javascript.min.js"></script>
220
 
  <script>highlight(undefined, undefined, 'pre');</script>
221
 
  <script>
222
 
    var gaJsHost = (("https:" == document.location.protocol) ?
223
 
    "https://ssl." : "http://www.");
224
 
    document.write(unescape("%3Cscript src='" + gaJsHost + "google-analytics.com/ga.js' type='text/javascript'%3E%3C/script%3E"));
225
 
  </script>
226
 
  <script>
227
 
    try {
228
 
      var pageTracker = _gat._getTracker("UA-10874194-2");
229
 
      pageTracker._trackPageview();
230
 
      } catch(err) {}</script>
231
 
</body>
232
 
</html>
233