progressbar

README

progressbar

A simple progress bar for golang projects. I created that because there was a long processus in some projet and I didn't know what was the progression.

Installation

go get -u github.com/disco07/progressbar

Usage

Basic usage

bar := progressbar.Default(100)
for i := 0; i < 100; i++ {
    bar.Add(1)
    time.Sleep(100 * time.Millisecond)
}

Contributing 🤝

Contributions, issues, and feature requests are welcome!

Feel free to check the issues page.

📝 License

Documentation

Index

• type Bar
  • func Default(end int64) *Bar
  • func New(end int64) *Bar
  • func (b *Bar) Add(num int) error
  • func (b *Bar) SetTheme(t Theme)
• type Theme

Types

type Bar

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

func Default

func Default(end int64) *Bar

Default is a basic usage of progress bar. In parameter, the max size of things you want to view progress. It returns a pointer of Bar.

func New

func New(end int64) *Bar

func (*Bar) Add

func (b *Bar) Add(num int) error

Add is a func who add the number passed as a parameter to the progress bar.

func (*Bar) SetTheme

func (b *Bar) SetTheme(t Theme)

type Theme

type Theme struct {
	GraphType  string
	GraphStart string
	GraphEnd   string
	GraphWidth int64
	// contains filtered or unexported fields
}