Interface ArgumentPrompterService

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

Index

Methods

promptForArguments promptForMissingArguments

Methods

promptForArguments

promptForArguments(
args: readonly (Option | ComplexOption)[],
existing?: Values,
): Promise<Values | undefined>
Prompt for a value for each of the specified arguments.
Parameters
- args: readonly (Option | ComplexOption)[]
  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).
- Defined in work/dynamic-cli-framework-api/dynamic-cli-framework-api/src/service/core/ArgumentPrompterService.ts:22

promptForMissingArguments

promptForMissingArguments(parseResult: ParseResult): Promise<ParseResult>
Parameters
- parseResult: ParseResult
Returns Promise<ParseResult>
- Defined in work/dynamic-cli-framework-api/dynamic-cli-framework-api/src/service/core/ArgumentPrompterService.ts:10