@flowscripter/dynamic-cli-framework
    Preparing search index...

    Interface ArgumentPrompterService

    interface ArgumentPrompterService {
        promptForArguments(
            args: readonly (ComplexOption | Option)[],
            existing?: Values,
        ): Promise<Values | undefined>;
        promptForMissingArguments(parseResult: ParseResult): Promise<ParseResult>;
    }

    Implemented by

    Index
    promptForArguments promptForMissingArguments

    • Prompt for a value for each of the specified arguments.

      Parameters

      • args: readonly (ComplexOption | Option)[]

        the arguments to prompt for.

      • Optionalexisting: Values

        optional values already provided, which are not prompted for and are visible to Argument.validate functions as ValidationContext.values.

      Returns Promise<Values | undefined>

      the prompted values, converted to their native types, or undefined if prompting is not possible (e.g. prompting has been disabled).

    • Parameters

      Returns Promise<ParseResult>

    Settings
    Member Visibility

    On This Page
    Methods