import Option from 'atscm-cli/src/lib/cli/Option.js'

public class | source

Option

A command line option.

Static Method Summary

Static Public Methods
public static	boolean(desc: string, options: Object): Option Shorthand to create an Option with type boolean.
public static	string(desc: string, options: Object): Option Shorthand to create an Option with type string.

Public Constructor
public	constructor(desc: string, options: Object) Creates a new Option based on a description and some options.

Public Members
public	desc: String A string describing the option.

Shorthand to create an Option with type boolean.

Name	Type	Attribute	Description
desc	string		A string describing the option. Used for help texts.
options	Object	optional default: {type: 'boolean'}	The options to create the Option with.

An Option with type boolean.

Shorthand to create an Option with type string.

Name	Type	Attribute	Description
desc	string		A string describing the option. Used for help texts.
options	Object	optional default: {type: 'string', requiresArg: true}	The options to create the Option with.

An Option with type string.

Creates a new Option based on a description and some options.

Name	Type	Attribute	Description
desc	string		A string describing the option. Used for help texts.
options	Object	optional default: {}	The options to create the Option with. Refer to yarg's documentation in order to know what options can be used here.

A string describing the option. Used for help texts.