Commit 277122e
lib: fix and improve os typings
1. marked optional params as such
2. assigned default values using jsdoc conventions.
PR-URL: #38316
Reviewed-By: James M Snell <jasnell@gmail.com>
Reviewed-By: Shingo Inoue <leko.noor@gmail.com>1 parent 28e1648 commit 277122e
1 file changed
Lines changed: 5 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -286,7 +286,7 @@ function networkInterfaces() { | |||
| 286 | 286 | } | |
| 287 | 287 | ||
| 288 | 288 | /** | |
| 289 | - * @param {number} pid | ||
| 289 | + * @param {number} [pid=0] | ||
| 290 | 290 | * @param {number} priority | |
| 291 | 291 | * @returns {void} | |
| 292 | 292 | */ | |
@@ -306,7 +306,7 @@ function setPriority(pid, priority) { | |||
| 306 | 306 | } | |
| 307 | 307 | ||
| 308 | 308 | /** | |
| 309 | - * @param {number} pid | ||
| 309 | + * @param {number} [pid=0] | ||
| 310 | 310 | * @returns {number} | |
| 311 | 311 | */ | |
| 312 | 312 | function getPriority(pid) { | |
@@ -325,9 +325,9 @@ function getPriority(pid) { | |||
| 325 | 325 | } | |
| 326 | 326 | ||
| 327 | 327 | /** | |
| 328 | - * @param {{ encoding?: string }} options If `encoding` is set to `'buffer'`, | ||
| 329 | - * the `username`, `shell`, and `homedir` values will be `Buffer` instances. | ||
| 330 | - * Default: `'utf8'` | ||
| 328 | + * @param {{ encoding?: string }} [options=utf8] If `encoding` is set to | ||
| 329 | + * `'buffer'`, the `username`, `shell`, and `homedir` values will | ||
| 330 | + * be `Buffer` instances. | ||
| 331 | 331 | * @returns {{ | |
| 332 | 332 | * uid: number | |
| 333 | 333 | * gid: number | |
0 commit comments