prompt

Documentation

Index

• type Input
• type Prompt
  • func NewPrompt(in io.Reader) Prompt
  • func (p *Prompt) Run(input Input) error
  • func (p *Prompt) RunSlice(inputs []Input) error

Types

type Input

type Input struct {
	// Message is a message to show when asking for an input. e.g. "Which platform to use?"
	Message string
	// TargetPointer is a pointer to the target variable to set the value of the input.
	TargetPointer any
	// Required indicates whether this input is required or not.
	Required bool
}

Input represents an query to ask from users.

type Prompt

type Prompt struct {
	// contains filtered or unexported fields
}

Prompt is a helper for asking inputs from users.

func NewPrompt

func NewPrompt(in io.Reader) Prompt

func (*Prompt) Run

func (p *Prompt) Run(input Input) error

Run asks for an input and set the value to the target pointer.

func (*Prompt) RunSlice

func (p *Prompt) RunSlice(inputs []Input) error

RunSlice sequentially asks for inputs and set the values to the target pointers.