We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
jsdoc
1 parent 6e85010 commit 298459fCopy full SHA for 298459f
1 file changed
src/argv2Object.mjs
@@ -49,6 +49,7 @@ import { formatKey, convertValue } from '#functions';
49
* @function
50
* @param {boolean} [unixmode=false] - Whether to parse Unix-style command-line options, the default value is `false`.
51
* @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`.
53
* @throws {Error} If no arguments are provided from command line.
54
* @throws {Error} If `unixmode` is `true` and argument does not follow Unix-style command-line format.
55
* @throws {Error} If `unixmode` is `false` and argument does not follow 'key=value' format.
0 commit comments