Skip to content

Commit 298459f

Browse files
committed
docs: update jsdoc
1 parent 6e85010 commit 298459f

1 file changed

Lines changed: 1 addition & 0 deletions

File tree

src/argv2Object.mjs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ import { formatKey, convertValue } from '#functions';
4949
* @function
5050
* @param {boolean} [unixmode=false] - Whether to parse Unix-style command-line options, the default value is `false`.
5151
* @returns {ArgvObject} Returns an object with keys and values corresponding to the provided arguments.
52+
* @throws {TypeError} If `unixmode` is not is not of type `boolean`.
5253
* @throws {Error} If no arguments are provided from command line.
5354
* @throws {Error} If `unixmode` is `true` and argument does not follow Unix-style command-line format.
5455
* @throws {Error} If `unixmode` is `false` and argument does not follow 'key=value' format.

0 commit comments

Comments
 (0)