prompt

Documentation

Overview

Package prompt inputs for user interactions.

Index

• Constants
• Variables
• func CtrlC()
• func IndexStrings(options *[]string, setup bool) string
• func Port(validate, setup bool) (port uint)
• func PortValid(port uint) (ok bool)
• func ShortStrings(options *[]string) string
• func SkipSet(setup bool) string
• func String() (words string)
• func Strings(options *[]string, setup bool) string
• func YesNo(ask string, yesDefault bool) bool

Examples

• YesNo

Constants

const (
	PortMin  uint = 1 // port 0 is not valid as viper treats it as a null value
	PortMax  uint = 65535
	NoChange      = "no changes applied"
)

the lowest, largest and recommended network ports to serve HTTP.

Variables

var (
	ErrNoReader = errors.New("reader interface is empty")
	ErrPString  = errors.New("prompt string standard input problem")
)

Functions

func CtrlC

func CtrlC()

CtrlC intercepts any Ctrl-C keyboard input and exits to the shell.

func IndexStrings

func IndexStrings(options *[]string, setup bool) string

IndexStrings asks for a numeric index position and returns a single choice from a string of keys.

func Port

func Port(validate, setup bool) (port uint)

Port asks for and returns a HTTP port value.

func PortValid

func PortValid(port uint) (ok bool)

PortValid checks if the network port is within range to serve HTTP.

func ShortStrings

func ShortStrings(options *[]string) string

ShortStrings asks for and returns a single choice from a string of keys. Either the first letter or the full name of the key are accepted.

func SkipSet

func SkipSet(setup bool) string

SkipSet returns a skipped setting string for the setup walk through.

func String

func String() (words string)

String asks for and returns a multi-word string. Inputting ⏎ the Enter/Return key exits the program, or returns an empty value when in SetupMode.

func Strings

func Strings(options *[]string, setup bool) string

Strings asks for and returns a single choice from a string of keys.

func YesNo

func YesNo(ask string, yesDefault bool) bool

YesNo asks for a yes or no input.

Example

yn := YesNo("Say hello", true)
fmt.Print(yn)

Output:

Say hello? [Yes/no] true