asker

package

v0.0.0-...-fe3d7fc Latest Latest Go to latest Published: Jan 9, 2021 License: Apache-2.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Asker struct {
	IsVimMode bool
	Mask      rune
	Stdin     io.ReadCloser
	Stdout    io.WriteCloser
}

Asker is a helper for retrieving user input from the given reader

func DefaultAsker() *Asker

DefaultAsker creates a asker using STDOUT and STDIN

func (a *Asker) Ask(question string, validations ...Validation) (string, error)

Ask retrieves user input from the current Reader

func (a *Asker) AskConfirm(question string) (bool, error)

AskConfirm retrieves confirmation and attempts to parse the various way that a use might supply confirmation e.g. yes, YES, y, si, yup etc.

func (a *Asker) AskSecret(question string, confirm bool, validations ...Validation) (string, error)

AskSecret asks for user input without echoing input back to terminal. Note that this method is only supported through stdin

func (a *Asker) AskSelect(question string, items []string) (int, error)

AskSelect prompts the user from a list of items and returns the index of the selected item

type Validation func(string) error

Validation defines a general validation processor for a given string