conventional-cli
Version:
Conventional for CLI tools
67 lines (66 loc) • 1.74 kB
TypeScript
import { IArgument } from '../interfaces';
import { ArgumentTypes } from '../types';
/** Argument object of usage's doc */
export declare class Argument implements IArgument {
/**
* The full name of the argument
* @type {?string | undefined}
*/
longName?: string | undefined;
/**
* The short name of the argument
* @type {?string | undefined}
*/
shortName?: string | undefined;
/**
* The description of the argument
* @type {?string | undefined}
*/
description?: string | undefined;
/**
* The type of argument
* @type {ArgumentType | undefined}
*/
type: ArgumentTypes | undefined;
/**
* The possible values of argument
* @type {?string[] | undefined}
*/
values?: string[] | undefined;
/**
* The default value of argument
* @type {?string | undefined}
*/
default?: string | undefined;
/**
* The argument is required
* @type {?boolean | undefined}
*/
required?: boolean | undefined;
/**
* The argument has value
* @type {?boolean | undefined}
*/
hasValue?: boolean | undefined;
/**
* The delimiter of argument
* @type {?string | undefined}
*/
delimiter?: string | undefined;
/**
* The argument has deprecated
* @type {?boolean | undefined}
*/
deprecated?: boolean | undefined;
/**
* The additional description of the argument
* @type {?string | undefined}
*/
additionalDescription?: string | undefined;
/**
* The argument is on the beta step and some functionality can be not work
* @type {?boolean | undefined}
*/
beta?: boolean | undefined;
constructor();
}