messages

package
v0.1.0 Latest Latest
Warning

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

Go to latest
Published: Nov 19, 2024 License: MIT Imports: 9 Imported by: 2

Documentation

Index

Constants

View Source
const EraseLineSequence = ansi.EraseEntireLine + "\r" + ansi.CursorUp1

Variables

View Source
var LoaderConfigDefault = LoaderConfig{
	Spinner: func() spinner.Model {
		loaderSpinner := spinner.New()
		loaderSpinner.Spinner = spinner.Meter
		loaderSpinner.Style = lipgloss.NewStyle().Foreground(lipgloss.Color("13"))

		return loaderSpinner
	}(),
}

Functions

func NewBase

func NewBase(message string, child quicklog.Message) quicklog.Message

NewBase groups together important logs under a section. Description and child are optional.

func NewError

func NewError(err error, message string) quicklog.Message

NewError creates a new error message.

func NewTitle

func NewTitle(title string, description string, child quicklog.Message) quicklog.Message

NewTitle groups together important logs under a section. Description and child are optional.

Types

type Loader

type Loader interface {
	quicklog.AnimatedMessage

	// Update sets a new message for the loader. It has no effect if called after Close, Success or Error.
	// If step is empty, the previous step will be re-rendered.
	Update(step string)

	// Nest adds more information to the loader in the form of an additional message.
	Nest(message quicklog.Message)

	// Success generates a success message, and closes the loader.
	// If step is empty, the previous step will be re-rendered.
	Success(step string)
	// Error generates an error message, and closes the loader.
	Error(err error)
}

func NewLoader

func NewLoader(step string, config *LoaderConfig) Loader

type LoaderConfig

type LoaderConfig struct {
	OpID            *uuid.UUID
	UpdateFrequency *time.Duration

	Spinner spinner.Model
}

Directories

Path Synopsis

Jump to

Keyboard shortcuts

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