progress

package
v0.0.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Sep 11, 2025 License: Apache-2.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (

	// #unused
	DoneColor colorFunc = color.BlueString
	// #unused
	TimerColor   colorFunc = color.BlueString
	CountColor   colorFunc = color.YellowString
	WarningColor colorFunc = color.YellowString
	SuccessColor colorFunc = color.GreenString
	ErrorColor   colorFunc = color.RedString
	// #unused
	PrefixColor colorFunc = color.CyanString
)

Functions

func NoColor

func NoColor()

Types

type Event

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

Event represents a progress event.

func CreatingEvent

func CreatingEvent(isParent bool) *Event

ErrorEvent creates a new Error Event

func NewEvent

func NewEvent(status EventStatus, isParent bool, colors ...string) *Event

NewEvent new event

func (*Event) Done

func (e *Event) Done(msg ...string) *Event

func (*Event) Error

func (e *Event) Error(msg ...string) *Event

func (*Event) Spinner

func (e *Event) Spinner() string

func (*Event) Start

func (e *Event) Start() *Event

func (*Event) Stop

func (e *Event) Stop() *Event

func (*Event) Success

func (e *Event) Success(msg ...string) *Event

func (*Event) Text

func (e *Event) Text() string

func (*Event) Warning

func (e *Event) Warning(msg ...string) *Event

func (*Event) WithText

func (e *Event) WithText(text string) *Event

type EventStatus

type EventStatus int
const (
	Running EventStatus = iota
	// Done means that the current task is done
	Done
	// Warning means that the current task has warning
	Warning
	// Error means that the current task has errored
	Error
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL