FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

doc,os: use code markup/markdown in headers · nodejs/node@4fa9959 · GitHub

/ node Public

Commit 4fa9959

Browse files
Trott
authored and
BethGriggs
committed
doc,os: use code markup/markdown in headers
Backport-PR-URL: #31108 PR-URL: #31086 Reviewed-By: Anna Henningsen <anna@addaleax.net> Reviewed-By: Ruben Bridgewater <ruben@bridgewater.de>
1 parent bff03ca commit 4fa9959

1 file changed

Lines changed: 19 additions & 19 deletions

File tree

‎doc/api/os.md‎

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ properties. It can be accessed using:
1111
const os = require('os');
1212
```
1313

14-
## os.EOL
14+
## `os.EOL`
1515
<!-- YAML
1616
added: v0.7.8
1717
-->
@@ -23,7 +23,7 @@ The operating system-specific end-of-line marker.
2323
* `\n` on POSIX
2424
* `\r\n` on Windows
2525

26-
## os.arch()
26+
## `os.arch()`
2727
<!-- YAML
2828
added: v0.5.0
2929
-->
@@ -36,7 +36,7 @@ compiled. Possible values are `'arm'`, `'arm64'`, `'ia32'`, `'mips'`,
3636

3737
The return value is equivalent to [`process.arch`][].
3838

39-
## os.constants
39+
## `os.constants`
4040
<!-- YAML
4141
added: v6.3.0
4242
-->
@@ -47,7 +47,7 @@ Contains commonly used operating system-specific constants for error codes,
4747
process signals, and so on. The specific constants defined are described in
4848
[OS Constants](#os_os_constants_1).
4949

50-
## os.cpus()
50+
## `os.cpus()`
5151
<!-- YAML
5252
added: v0.3.3
5353
-->
@@ -120,7 +120,7 @@ The properties included on each object include:
120120
`nice` values are POSIX-only. On Windows, the `nice` values of all processors
121121
are always 0.
122122

123-
## os.endianness()
123+
## `os.endianness()`
124124
<!-- YAML
125125
added: v0.9.4
126126
-->
@@ -132,7 +132,7 @@ binary was compiled.
132132

133133
Possible values are `'BE'` for big endian and `'LE'` for little endian.
134134

135-
## os.freemem()
135+
## `os.freemem()`
136136
<!-- YAML
137137
added: v0.3.3
138138
-->
@@ -141,7 +141,7 @@ added: v0.3.3
141141

142142
Returns the amount of free system memory in bytes as an integer.
143143

144-
## os.getPriority(\[pid\])
144+
## `os.getPriority([pid])`
145145
<!-- YAML
146146
added: v10.10.0
147147
-->
@@ -153,7 +153,7 @@ added: v10.10.0
153153
Returns the scheduling priority for the process specified by `pid`. If `pid` is
154154
not provided or is `0`, the priority of the current process is returned.
155155

156-
## os.homedir()
156+
## `os.homedir()`
157157
<!-- YAML
158158
added: v2.3.0
159159
-->
@@ -168,7 +168,7 @@ uses the [effective UID][EUID] to look up the user's home directory.
168168
On Windows, it uses the `USERPROFILE` environment variable if defined.
169169
Otherwise it uses the path to the profile directory of the current user.
170170

171-
## os.hostname()
171+
## `os.hostname()`
172172
<!-- YAML
173173
added: v0.3.3
174174
-->
@@ -177,7 +177,7 @@ added: v0.3.3
177177

178178
Returns the hostname of the operating system as a string.
179179

180-
## os.loadavg()
180+
## `os.loadavg()`
181181
<!-- YAML
182182
added: v0.3.3
183183
-->
@@ -192,7 +192,7 @@ system and expressed as a fractional number.
192192
The load average is a Unix-specific concept. On Windows, the return value is
193193
always `[0, 0, 0]`.
194194

195-
## os.networkInterfaces()
195+
## `os.networkInterfaces()`
196196
<!-- YAML
197197
added: v0.6.0
198198
-->
@@ -263,7 +263,7 @@ The properties available on the assigned network address object include:
263263
}
264264
```
265265

266-
## os.platform()
266+
## `os.platform()`
267267
<!-- YAML
268268
added: v0.5.0
269269
-->
@@ -279,7 +279,7 @@ The return value is equivalent to [`process.platform`][].
279279
The value `'android'` may also be returned if Node.js is built on the Android
280280
operating system. [Android support is experimental][Android building].
281281

282-
## os.release()
282+
## `os.release()`
283283
<!-- YAML
284284
added: v0.3.3
285285
-->
@@ -292,7 +292,7 @@ On POSIX systems, the operating system release is determined by calling
292292
[uname(3)][]. On Windows, `GetVersionExW()` is used. See
293293
https://en.wikipedia.org/wiki/Uname#Examples for more information.
294294

295-
## os.setPriority(\[pid, \]priority)
295+
## `os.setPriority([pid, ]priority)`
296296
<!-- YAML
297297
added: v10.10.0
298298
-->
@@ -315,7 +315,7 @@ On Windows, setting priority to `PRIORITY_HIGHEST` requires elevated user
315315
privileges. Otherwise the set priority will be silently reduced to
316316
`PRIORITY_HIGH`.
317317

318-
## os.tmpdir()
318+
## `os.tmpdir()`
319319
<!-- YAML
320320
added: v0.9.9
321321
changes:
@@ -330,7 +330,7 @@ changes:
330330
Returns the operating system's default directory for temporary files as a
331331
string.
332332

333-
## os.totalmem()
333+
## `os.totalmem()`
334334
<!-- YAML
335335
added: v0.3.3
336336
-->
@@ -339,7 +339,7 @@ added: v0.3.3
339339

340340
Returns the total amount of system memory in bytes as an integer.
341341

342-
## os.type()
342+
## `os.type()`
343343
<!-- YAML
344344
added: v0.3.3
345345
-->
@@ -352,7 +352,7 @@ returns `'Linux'` on Linux, `'Darwin'` on macOS, and `'Windows_NT'` on Windows.
352352
See https://en.wikipedia.org/wiki/Uname#Examples for additional information
353353
about the output of running [uname(3)][] on various operating systems.
354354

355-
## os.uptime()
355+
## `os.uptime()`
356356
<!-- YAML
357357
added: v0.3.3
358358
changes:
@@ -366,7 +366,7 @@ changes:
366366

367367
Returns the system uptime in number of seconds.
368368

369-
## os.userInfo(\[options\])
369+
## `os.userInfo([options])`
370370
<!-- YAML
371371
added: v6.0.0
372372
-->

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL