Skip to content

Commit e675c3a

Browse files
bakkotmarco-ippolito
authored andcommitted
doc: expand description of parseArg's default
PR-URL: #54431 Reviewed-By: James M Snell <[email protected]> Reviewed-By: Luigi Pinca <[email protected]> Reviewed-By: Jordan Harband <[email protected]>
1 parent 48f9ca0 commit e675c3a

File tree

1 file changed

+4
-3
lines changed

1 file changed

+4
-3
lines changed

doc/api/util.md

+4-3
Original file line numberDiff line numberDiff line change
@@ -1422,9 +1422,10 @@ changes:
14221422
times. If `true`, all values will be collected in an array. If
14231423
`false`, values for the option are last-wins. **Default:** `false`.
14241424
* `short` {string} A single character alias for the option.
1425-
* `default` {string | boolean | string\[] | boolean\[]} The default option
1426-
value when it is not set by args. It must be of the same type as the
1427-
`type` property. When `multiple` is `true`, it must be an array.
1425+
* `default` {string | boolean | string\[] | boolean\[]} The default value to
1426+
be used if (and only if) the option does not appear in the arguments to be
1427+
parsed. It must be of the same type as the `type` property. When `multiple`
1428+
is `true`, it must be an array.
14281429
* `strict` {boolean} Should an error be thrown when unknown arguments
14291430
are encountered, or when arguments are passed that do not match the
14301431
`type` configured in `options`.

0 commit comments

Comments
 (0)