IOption

Option interface.

Used by flags and options, which both contain short and long names. Either can be null but not both.

interface IOption : IEntry {

typeof(this) full(string full);

string full();

alias long_ = full;

typeof(this) abbrev(string abbrev);

string abbrev();

alias short_ = abbrev;

}

Members

Aliases

long_ alias long_ = full: Option full name (long-form).
short_ alias short_ = abbrev: Sets option abbrevation (short-form).

Functions

abbrev typeof(this) abbrev(string abbrev): Sets option abbrevation (short-form).
abbrev string abbrev(): Sets option abbrevation (short-form).
full typeof(this) full(string full): Sets option full name (long-form).
full string full(): Option full name (long-form).

Inherited Members

From IEntry

name typeof(this) name(string name): Sets entry name.
name string name(): Entry name.
displayName string displayName(): Display name for entry.
description typeof(this) description(string description): Sets entry help description (one-liner).
description string description(): Entry help description (one-liner).
repeating typeof(this) repeating(bool repeating = true): Sets whenever entry can be repeated.
isRepeating bool isRepeating(): Gets whenever entry can be repeated.
required typeof(this) required(bool required = true): Sets entry required flag.
optional typeof(this) optional(bool optional = true): Sets entry optional flag.
isRequired bool isRequired(): Whenever entry is required.
defaultValue typeof(this) defaultValue(string defaultValue): Sets entry default value.
defaultValue typeof(this) defaultValue(string[] defaultValue): Sets entry default value array.
defaultValue string[] defaultValue(): Entry default value array.
validate typeof(this) validate(IValidator validator): Adds entry validator.
validators IValidator[] validators(): Entry validators.

Meta

Source

See Implementation

commandr option classes

interfaces

mixin templates