import InitOption from 'atscm/src/lib/init/Option.js'

public class | source

InitOption

An option the "atscm init" command handles. TODO: Support function values for name, message, default, choices...

Static Member Summary

Static Public Members
public static get	DefaultType: inquirer~PromptType: string The default inquirer~PromptType to use.

Public Constructor
public	constructor(messageOrOptions: string \| Object, defaultOrUndefined: string \| number) Creates a new option based either on a message and (optionally) a default value or some options.

Public Members
public	choices: String[] \| Number[] \| undefined The choices available.
public	default: String \| Number \| undefined The default value to use.
public	message: String The option's message. A '?' sign is added automatically.
public	type: inquirer~PromptType The option's inquirer~PromptType. Defaults to 'input'.
public	validate: inquirer~Validator Validates the user input for this option.
public	when: Boolean \| function(answers: Object): Boolean \| undefined A function or boolean that indicates weather or not to prompt this option.

The default inquirer~PromptType to use. Equals 'input'.

The default inquirer~PromptType to use.

Creates a new option based either on a message and (optionally) a default value or some options.

Name	Type	Attribute	Description
messageOrOptions	string \| Object		The message or options to use.
messageOrOptions.type	inquirer~PromptType	optional	The option's type.
messageOrOptions.message	string		The option's message. Required if `messageOrOptions` is an object.
messageOrOptions.default	string \| number	optional	The options's default value.
messageOrOptions.validate	inquirer~Validator	optional	A function that validates user input.
messageOrOptions.choices	string[] \| number[]	optional	The options's choices. Applies to to list types only.
messageOrOptions.when	boolean \| function(answers: Object): boolean	optional	Weather or not to prompt this option.
defaultOrUndefined	string \| number	optional	The default value to use.

The choices available. Applies to list types only.

The default value to use.

The option's message. A '?' sign is added automatically.

The option's inquirer~PromptType. Defaults to 'input'.

Validates the user input for this option.

A function or boolean that indicates weather or not to prompt this option.