Interface ArgSpecBase

interface ArgSpecBase {
    alias?: string;
    defaultHint?: string;
    desc?: string;
    fn?: Fn<string, boolean>;
    group?: string;
    hint?: string;
}

Properties

alias?: string

Shorthand for given arg/option

defaultHint?: string

Custom string representation of default value (e.g. a hex value)

desc?: string

Description (for usage only)

fn?: Fn<string, boolean>

Predicate function called when this arg is being parsed. Function MUST return true for parsing to continue.

group?: string

Group ID this arg belongs to. By default args belong to a "main" group. flag args are associated with the "flags" group (by default).

See UsageOpts.groups for more details.

hint?: string

Type hint (for usage only)

Generated using TypeDoc