Module: jsdoc/opts/args

Requires

Members

ArgParser

Source:

argParser

Source:

args

Source:

cast

Source:

hasOwnProp

Source:

ourOptions

Source:

querystring

Source:

Methods

get() → {Object}

Get all the options for this app.
Source:
Returns:
A collection of key/values representing all the options.
Type
Object

get(name) → {string}

Get a named option.
Parameters:
Name Type Description
name string The name of the option.
Source:
Returns:
The value associated with the given name.
Type
string

help()

Retrieve help message for options.
Source:

parse(args)

Set the options for this app.
Parameters:
Name Type Description
args string | Array.<String> The command line arguments for this app.
Source:
Throws:
Illegal arguments will throw errors.
Type
Error

parseQuery()

Source: