prompt

Documentation

Overview

Package prompt prompts user for feedback.

Index

• type Option
  • func NewOption(key interface{}, prompt string, other bool) Option
  • func ValidateOption(opt Option, validation string) Option
  • func (opt Option) Key() interface{}
  • func (opt Option) Other() bool
  • func (opt Option) Prompt() string
  • func (opt Option) String() string
  • func (opt Option) Validation() string
• type OptionType
• type Prompt
• type Question
  • func (q *Question) AnswerMultiple(must bool) []*Option
  • func (q *Question) AnswerSingle(must bool) *Option
• type Response

Types

type Option

type Option struct {
	Chosen bool   // Set to true if chosen.
	Value  string // Value used if chosen and option is "other".
	// contains filtered or unexported fields
}

func NewOption

func NewOption(key interface{}, prompt string, other bool) Option

func ValidateOption

func ValidateOption(opt Option, validation string) Option

func (Option) Key

func (opt Option) Key() interface{}

func (Option) Other

func (opt Option) Other() bool

func (Option) Prompt

func (opt Option) Prompt() string

func (Option) String

func (opt Option) String() string

func (Option) Validation

func (opt Option) Validation() string

type OptionType

type OptionType byte

const (
	TypeSelectOne      OptionType = iota // Allow user to choose single option.
	TypeSelectMultiple                   // Allow user to choose multiple options.
)

type Prompt

type Prompt interface {
	Ask(q *Question) (Response, error)
}

type Question

type Question struct {
	Error   string
	Prompt  string
	Type    OptionType
	Options []Option
}

func (*Question) AnswerMultiple

func (q *Question) AnswerMultiple(must bool) []*Option

func (*Question) AnswerSingle

func (q *Question) AnswerSingle(must bool) *Option

type Response

type Response byte

const (
	RespAnswer Response = iota
	RespCancel
)