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 <[email protected]> Reviewed-By: Shingo Inoue <[email protected]>
nodejs · May 30, 2021 · cd1b13e · cd1b13e
1 parent 7af352c
commit cd1b13e
Showing 1 changed file with 5 additions and 5 deletions.
diff --git a/lib/os.js b/lib/os.js
@@ -286,7 +286,7 @@ function networkInterfaces() {
 }
 
 /**
- * @param {number} pid
+ * @param {number} [pid=0]
  * @param {number} priority
  * @returns {void}
  */
@@ -306,7 +306,7 @@ function setPriority(pid, priority) {
 }
 
 /**
- * @param {number} pid
+ * @param {number} [pid=0]
  * @returns {number}
  */
 function getPriority(pid) {
@@ -325,9 +325,9 @@ function getPriority(pid) {
 }
 
 /**
- * @param {{ encoding?: string }} options If `encoding` is set to `'buffer'`,
- * the `username`, `shell`, and `homedir` values will be `Buffer` instances.
- * Default: `'utf8'`
+ * @param {{ encoding?: string }} [options=utf8] If `encoding` is set to
+ * `'buffer'`, the `username`, `shell`, and `homedir` values will
+ * be `Buffer` instances.
  * @returns {{
  *   uid: number
  *   gid: number