key

Documentation

Index

• Constants
• type TKey
  • func New() *TKey
  • func (k *TKey) Get(keyDefault string, ttl int) (result string, err error)

Constants

const CodeESC = 27 // \x1b = \d27= ESC

Types

type TKey

type TKey struct {
	KeyDefault      string  // The key to be returned if time out occurs
	TTL             int     // The time wait user input in seconds
	DescriptorFile  uintptr // For os.Stdout.Fd dependency injection
	ForceDefault    bool    // If true it will return the default key (for testing)
	DurationDefault int     // The default time wait user input in seconds
}

func New

func New() *TKey

New returns a new TKey instance pointer with default settings.

func (*TKey) Get

func (k *TKey) Get(keyDefault string, ttl int) (result string, err error)

Get returns the key from the user input.