Skip to content
Closed
Changes from 1 commit
Commits
Show all changes
32 commits
Select commit Hold shift + click to select a range
ecd2179
doc: sort assert alphabetically
tflanagan Nov 4, 2015
63a2e55
doc: sort buffer alphabetically
tflanagan Nov 4, 2015
7b4f78a
doc: sort child_process alphabetically
tflanagan Nov 4, 2015
e650680
doc: sort cluster alphabetically
tflanagan Nov 4, 2015
cfed942
doc: sort console alphabetically
tflanagan Nov 4, 2015
03dd92c
doc: sort dns alphabetically
tflanagan Nov 4, 2015
d9e5b6a
doc: sort crypto alphabetically
tflanagan Nov 4, 2015
43f2da0
doc: sort dgram alphabetically
tflanagan Nov 4, 2015
b85d3ac
doc: sort errors alphabetically
tflanagan Nov 4, 2015
03129f8
doc: sort events alphabetically
tflanagan Nov 4, 2015
c44523a
doc: sort fs alphabetically
tflanagan Nov 4, 2015
0c181d1
doc: sort globals alphabetically
tflanagan Nov 4, 2015
99c8160
doc: sort os alphabetically
tflanagan Nov 4, 2015
820506e
doc: sort path alphabetically
tflanagan Nov 4, 2015
33a6975
doc: sort punycode alphabetically
tflanagan Nov 4, 2015
5c37462
doc: sort querystring alphabetically
tflanagan Nov 4, 2015
ac62941
doc: sort vm alphabetically
tflanagan Nov 4, 2015
8c83054
doc: sort url alphabetically
tflanagan Nov 4, 2015
cc6f224
doc: sort tty alphabetically
tflanagan Nov 4, 2015
15a8370
doc: sort timers alphabetically
tflanagan Nov 4, 2015
da7afdc
doc: sort string_decoder alphabetically
tflanagan Nov 4, 2015
059c98a
doc: sort repl alphabetically
tflanagan Nov 4, 2015
7ccad23
doc: sort readline alphabetically
tflanagan Nov 4, 2015
89122ce
doc: sort modules alphabetically
tflanagan Nov 4, 2015
3595327
doc: sort http alphabetically
tflanagan Nov 4, 2015
bed67d2
doc: sort https alphabetically
tflanagan Nov 4, 2015
5b09a1c
doc: sort util alphabetically
tflanagan Nov 5, 2015
37d037b
doc: sort zlib alphabetically
tflanagan Nov 5, 2015
8dbd518
doc: sort process alphabetically
tflanagan Nov 5, 2015
9811315
doc: sort net alphabetically
tflanagan Nov 5, 2015
e8c1e06
doc: sort stream alphabetically
tflanagan Nov 5, 2015
1b86f37
doc: sort tls alphabetically
tflanagan Nov 5, 2015
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
doc: sort os alphabetically
Reorders, with no contextual changes, the os documentation alphabetically.
  • Loading branch information
tflanagan committed Nov 5, 2015
commit 99c8160f37f7557c1216fd7f327ed4eb8f76796b
114 changes: 57 additions & 57 deletions doc/api/os.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -6,67 +6,16 @@ Provides a few basic operating-system related utility functions.

Use `require('os')` to access this module.

## os.tmpdir()

Returns the operating system's default directory for temporary files.

## os.homedir()

Returns the home directory of the current user.

## os.endianness()

Returns the endianness of the CPU. Possible values are `'BE'` for big endian
or `'LE'` for little endian.

## os.hostname()

Returns the hostname of the operating system.

## os.type()

Returns the operating system name. For example `'Linux'` on Linux, `'Darwin'`
on OS X and `'Windows_NT'` on Windows.

## os.platform()
## os.EOL

Returns the operating system platform. Possible values are `'darwin'`,
`'freebsd'`, `'linux'`, `'sunos'` or `'win32'`. Returns the value of
`process.platform`.
A constant defining the appropriate End-of-line marker for the operating
system.

## os.arch()

Returns the operating system CPU architecture. Possible values are `'x64'`,
`'arm'` and `'ia32'`. Returns the value of `process.arch`.

## os.release()

Returns the operating system release.

## os.uptime()

Returns the system uptime in seconds.

## os.loadavg()

Returns an array containing the 1, 5, and 15 minute load averages.

The load average is a measure of system activity, calculated by the operating
system and expressed as a fractional number. As a rule of thumb, the load
average should ideally be less than the number of logical CPUs in the system.

The load average is a very UNIX-y concept; there is no real equivalent on
Windows platforms. That is why this function always returns `[0, 0, 0]` on
Windows.

## os.totalmem()

Returns the total amount of system memory in bytes.

## os.freemem()

Returns the amount of free system memory in bytes.

## os.cpus()

Returns an array of objects containing information about each CPU/core
Expand Down Expand Up @@ -143,6 +92,35 @@ Example inspection of os.cpus:
Note that since `nice` values are UNIX centric in Windows the `nice` values of
all processors are always 0.

## os.endianness()

Returns the endianness of the CPU. Possible values are `'BE'` for big endian
or `'LE'` for little endian.

## os.freemem()

Returns the amount of free system memory in bytes.

## os.homedir()

Returns the home directory of the current user.

## os.hostname()

Returns the hostname of the operating system.

## os.loadavg()

Returns an array containing the 1, 5, and 15 minute load averages.

The load average is a measure of system activity, calculated by the operating
system and expressed as a fractional number. As a rule of thumb, the load
average should ideally be less than the number of logical CPUs in the system.

The load average is a very UNIX-y concept; there is no real equivalent on
Windows platforms. That is why this function always returns `[0, 0, 0]` on
Windows.

## os.networkInterfaces()

Get a list of network interfaces:
Expand Down Expand Up @@ -173,7 +151,29 @@ Get a list of network interfaces:
Note that due to the underlying implementation this will only return network
interfaces that have been assigned an address.

## os.EOL
## os.platform()

A constant defining the appropriate End-of-line marker for the operating
system.
Returns the operating system platform. Possible values are `'darwin'`,
`'freebsd'`, `'linux'`, `'sunos'` or `'win32'`. Returns the value of
`process.platform`.

## os.release()

Returns the operating system release.

## os.tmpdir()

Returns the operating system's default directory for temporary files.

## os.totalmem()

Returns the total amount of system memory in bytes.

## os.type()

Returns the operating system name. For example `'Linux'` on Linux, `'Darwin'`
on OS X and `'Windows_NT'` on Windows.

## os.uptime()

Returns the system uptime in seconds.