task

Documentation

Index

• type Option
  • func WithNoOutput() Option
• type Task
  • func New(category string, description string, f func(t *Task) error, opts ...Option) *Task
  • func (t *Task) Run() error
  • func (t *Task) Skip()
  • func (t *Task) StopAnimation()

Types

type Option

type Option func(*Task)

func WithNoOutput

func WithNoOutput() Option

type Task

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

func New

func New(category string, description string, f func(t *Task) error, opts ...Option) *Task

New creates a new task.

func (*Task) Run

func (t *Task) Run() error

Run runs the task, providing animated output as it does so. If the task fails, the error from the task function will be returned here.

func (*Task) Skip

func (t *Task) Skip()

func (*Task) StopAnimation

func (t *Task) StopAnimation()