Skip to content

Commit 6411076

Browse files
cjihrigErickWendel
authored andcommitted
doc: move os.machine() docs to sorted position
This commit moves the os.machine() docs so that the API list is sorted. PR-URL: nodejs#45647 Reviewed-By: Richard Lau <rlau@redhat.com> Reviewed-By: Moshe Atlow <moshe@atlow.co.il> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent 4a6d82c commit 6411076

File tree

1 file changed

+18
-18
lines changed

1 file changed

+18
-18
lines changed

doc/api/os.md

+18-18
Original file line numberDiff line numberDiff line change
@@ -220,6 +220,24 @@ system and expressed as a fractional number.
220220
The load average is a Unix-specific concept. On Windows, the return value is
221221
always `[0, 0, 0]`.
222222

223+
## `os.machine()`
224+
225+
<!-- YAML
226+
added:
227+
- v18.9.0
228+
- v16.18.0
229+
-->
230+
231+
* Returns {string}
232+
233+
Returns the machine type as a string, such as `arm`, `arm64`, `aarch64`,
234+
`mips`, `mips64`, `ppc64`, `ppc64le`, `s390`, `s390x`, `i386`, `i686`, `x86_64`.
235+
236+
On POSIX systems, the machine type is determined by calling
237+
[`uname(3)`][]. On Windows, `RtlGetVersion()` is used, and if it is not
238+
available, `GetVersionExW()` will be used. See
239+
<https://en.wikipedia.org/wiki/Uname#Examples> for more information.
240+
223241
## `os.networkInterfaces()`
224242

225243
<!-- YAML
@@ -452,24 +470,6 @@ On POSIX systems, the operating system release is determined by calling
452470
available, `GetVersionExW()` will be used. See
453471
<https://en.wikipedia.org/wiki/Uname#Examples> for more information.
454472

455-
## `os.machine()`
456-
457-
<!-- YAML
458-
added:
459-
- v18.9.0
460-
- v16.18.0
461-
-->
462-
463-
* Returns {string}
464-
465-
Returns the machine type as a string, such as `arm`, `arm64`, `aarch64`,
466-
`mips`, `mips64`, `ppc64`, `ppc64le`, `s390`, `s390x`, `i386`, `i686`, `x86_64`.
467-
468-
On POSIX systems, the machine type is determined by calling
469-
[`uname(3)`][]. On Windows, `RtlGetVersion()` is used, and if it is not
470-
available, `GetVersionExW()` will be used. See
471-
<https://en.wikipedia.org/wiki/Uname#Examples> for more information.
472-
473473
## OS constants
474474

475475
The following constants are exported by `os.constants`.

0 commit comments

Comments
 (0)