cli-worker

Module: Feature_CmdLineOptions

Parse command line arguments using minimist and store the parsed object into app.argv, and add app.showUsage() helper function

Source:
features/cmdLineOptions.js

Members

<static> type :string

This feature is loaded at configuration stage

Type:
  • string
Source:
features/cmdLineOptions.js

Methods

<static> load_(app, usageOptions)

Load the feature

Parameters:
Name Type Description
app CliApp

The cli app module object
usageOptions object

Options for the feature
Properties:
Name Type Argument Description
usageOptions.banner string <optional>

Banner message or banner generator function
usageOptions.program string <optional>

Executable name
usageOptions.arguments array <optional>

Command line arguments, identified by the position of appearance
usageOptions.options object <optional>

Command line options
Source:
features/cmdLineOptions.js
Returns:
Type
Promise.<*>