spinner

Documentation

Index

• type Options
• type Spinner
  • func New(text string, opts Options) *Spinner
  • func (s *Spinner) Error(text string)
  • func (s *Spinner) Start()
  • func (s *Spinner) Success(text string)
  • func (s *Spinner) Update(text string)

Types

type Options

type Options struct {
	Indent uint `json:"indent,omitempty"`
}

type Spinner

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

Spinner represents a terminal spinner.

func New

func New(text string, opts Options) *Spinner

New returns a new Spinner.

func (*Spinner) Error

func (s *Spinner) Error(text string)

Error stops the spinner with the error message that is specified in the Options.

func (*Spinner) Start

func (s *Spinner) Start()

Start starts the spinner.

func (*Spinner) Success

func (s *Spinner) Success(text string)

Success stops the spinner with the success message that is specified in the Options.

func (*Spinner) Update

func (s *Spinner) Update(text string)

Update replaces the spinner's message with the specified one.