fynjs API
    Preparing search index...

    Type Alias CommandMeta

    Represents JSON metadata for a command.

    type CommandMeta = {
        alias?: string;
        argList: string[];
        args: Record<string, ArgumentValue>;
        ccLong?: string;
        name?: string;
        opts: Record<string, OptionValue>;
        optsCount: Record<string, number>;
        optsFull: Record<string, Record<string, ArgumentValue>>;
        source: Record<string, OptionSource>;
        subCommands: Record<string, CommandMeta>;
        unknown?: boolean;
        verbatim: Record<string, string | string[]>;
    }
    Index
    alias? argList args ccLong? name? opts optsCount optsFull source subCommands unknown? verbatim
    alias?: string

    Alias for the command.

    argList: string[]

    List of all arguments passed to the command, even unknown ones.

    args: Record<string, ArgumentValue>

    Formally specified and recognized arguments passed to the command. Keys are argument names from the args spec, values are parsed values.

    ccLong?: string

    CamelCase version of the long option.

    name?: string

    Name of the command.

    opts: Record<string, OptionValue>

    Options associated with the command. Keys are option names, values are the parsed option values.

    optsCount: Record<string, number>

    Count of each option used (for counting options).

    optsFull: Record<string, Record<string, ArgumentValue>>

    Full options associated with the command (including array indices). Each entry is the option's full args map, keyed by arg name (or index for unnamed args), which is why the value is a record and not a bare value.

    source: Record<string, OptionSource>

    Source tracking for options - indicates where each option value came from.

    subCommands: Record<string, CommandMeta>

    Sub-commands associated with this command.

    unknown?: boolean

    Indicates if the command is unknown.

    verbatim: Record<string, string | string[]>

    Verbatim (original string) values for options before type coercion.

    Settings
    Member Visibility

    On This Page
    Properties