Skip to content

Commit

Permalink
doc: sort os alphabetically
Browse files Browse the repository at this point in the history
Reorders, with no contextual changes, the os documentation alphabetically.

PR-URL: #3662
Reviewed-By: Evan Lucas <[email protected]>
Reviewed-By: James M Snell <[email protected]>
Reviewed-By: Jeremiah Senkpiel <[email protected]>
  • Loading branch information
tflanagan authored and rvagg committed Nov 13, 2015
1 parent 4ba1848 commit 22961e0
Showing 1 changed file with 57 additions and 57 deletions.
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.

0 comments on commit 22961e0

Please sign in to comment.