IEntry

Interface for all program or command entries - flags, options and arguments.

interface IEntry {

typeof(this) name(string name);

string name();

string displayName();

typeof(this) description(string description);

string description();

typeof(this) repeating(bool repeating = true);

bool isRepeating();

typeof(this) required(bool required = true);

typeof(this) optional(bool optional = true);

bool isRequired();

typeof(this) defaultValue(string defaultValue);

typeof(this) defaultValue(string[] defaultValue);

string[] defaultValue();

typeof(this) validate(IValidator validator);

IValidator[] validators();

}

Members

Functions

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.
description typeof(this) description(string description): Sets entry help description (one-liner).
description string description(): Entry help description (one-liner).
displayName string displayName(): Display name for entry.
isRepeating bool isRepeating(): Gets whenever entry can be repeated.
isRequired bool isRequired(): Whenever entry is required.
name typeof(this) name(string name): Sets entry name.
name string name(): Entry name.
optional typeof(this) optional(bool optional = true): Sets entry optional flag.
repeating typeof(this) repeating(bool repeating = true): Sets whenever entry can be repeated.
required typeof(this) required(bool required = true): Sets entry required flag.
validate typeof(this) validate(IValidator validator): Adds entry validator.
validators IValidator[] validators(): Entry validators.

Meta

Source

See Implementation

commandr option classes

interfaces

mixin templates