fynjs API
    Preparing search index...

    Type Alias ParseResult

    Represents the result of parsing command-line arguments.

    type ParseResult = {
        _: string[];
        "[_ASYNC_EXEC]"?: string[];
        argv: string[];
        command: CommandNode;
        errorNodes?: ClapNode[];
        execCmd?: CommandNode;
        helpNode?: CommandNode;
        index: number;
    }
    Index
    _ [_ASYNC_EXEC]? argv command errorNodes? execCmd? helpNode? index

    _

    _: string[]

    Remaining args after -- if it was specified.

    Optional Internal[_ASYNC_EXEC]

    "[_ASYNC_EXEC]"?: string[]

    Names of commands whose exec returned a promise while being invoked synchronously. Populated by runExec / invokeExec only; runExecAsync awaits handlers instead.

    argv: string[]

    Array of all arguments passed to the command.

    command: CommandNode

    The root command of the parsed CLI args structure.

    errorNodes?: ClapNode[]

    Optional array of nodes that encountered errors during parsing.

    execCmd?: CommandNode

    The command that was executed (set after runExec/runExecAsync).

    helpNode?: CommandNode

    The command node where --help was specified (set by _checkFailures when help is requested)

    index: number

    The current index in the argument list, in case not everything was consumed.

    Settings
    Member Visibility

    On This Page
    Properties