spinner

Documentation

Overview

Package spinner contains functions for displaying progress updates with a spinning icon that shows the user that progress is being made.

Index

• func Pause()
• func Pop()
• func Push(status string)
• func Resume()
• func StartTimer(status string)
• func Stop()
• func StopTimer()
• func Update()

Functions

func Pause

func Pause()

Pause pauses the spinner so that you can interact with the console

func Pop

func Pop()

Pop removes the move recent status and stops the spinner if there are no more messages

func Push

func Push(status string)

Push enables the spinner and displays the provided message

func Resume

func Resume()

Resume resumes the spinner

func StartTimer

func StartTimer(status string)

StartTimer enables the spinner and displays a timer counting upwards from 0

func Stop

func Stop()

Stop empties all spinner messages and stops the spinner

func StopTimer

func StopTimer()

StopTimer disables the timer

func Update

func Update()

Update causes the spinner to update - use this if you have changed the display and need the spinner to redraw