string or array to be parsed.
parser options.
Ensures a default value when current is undefined.
the current value.
the default value.
Expand argument string into an array respecting space between special characters.
NOTE: use \ to escape inner quotes.
the arg string to split to array.
chars when matched ignore spaces withing these chars.
same as match except these chars will be included in result.
Expands options arguments into multiple singular arguments.
the value to be expanded.
when true short flag groups can have values.
Checks if object has own property key.
the object the key belongs to.
the key to inspect.
Checks if a value contains arg tokens.
the value to inspect.
Checks globally if any in string is an arg expression.
the value to inspect.
Checks if argument contans dot notation.
the value to inspect.
Check if argument contains optional argument tokens.
the value to be inspected.
Checks globally if any in string is an optional arg.
the value to inspect.
Checks if an argument contains required tokens.
the value to inspect.
Checks globally if any in string is a required arg.
the value to inspect.
Checks if an argument contains variadic characters.
the value to be inspected.
the variadic char to check if exists.
Checks if an argument is variadic and also contains required tokens.
the value to inspect.
the char representing variadic arguments.
Check if a flag option contains dot notation.
the value to inspect.
Checks if value is a flag option.
the value to inpsect.
Checks globally if any in string is a flag expression.
the value to inspect.
Checks if a flag option is of type count.
the value to inspect.
Checks if argument array contains a flag option next.
an array containing flags or arguments.
the current index to inspect from.
Checks if the previous argument is a flag option.
an array containing flag and/or argument options.
the current index to inspect from.
Checks if a flag option is of the short variety.
the value to inspect.
Checks if a val is boolean like.
the value to inspect.
Checks if value is number like.
the value to inspect.
Checks if flag is that of negation.
the value to inspect.
the negation char to check if exists.
Inspect variadic config value returning bool if truthy.
the value to check.
Parses provided arguments or uses process.argv.
string or array to be parsed.
parser options.
Strips a flag of all tokens.
the value containing flag tokens to be stripped.
the negation char defined in options.
Strips negate chars from flag.
the value to be stripped.
the characters denoting negate.
Strips all tokens from string.
the val containing tokens to be stripped.
the negation char used.
the variadic char used.
Strips variadic chars from flag.
the value to be stripped.
Camelize string, ignore dot notation strings when strict.
the value to camelize
when true dot notation values ignored.
Generated using TypeDoc
Parses provided arguments or uses process.argv.
.parse('install /some/path --force);
.parse('sip show log -vvvvv) >> { v: 5 }
.parse('--user.name=Jim') >> { user: { name: 'Jim' } }