Lux SDKGoPackages

ux

Package ux provides user experience utilities for CLI output formatting.

import "github.com/luxfi/sdk/ux"

Package ux provides user experience utilities for CLI output formatting.

Functions

ConvertToStringWithThousandSeparator

func ConvertToStringWithThousandSeparator(input uint64) string

DefaultTable

func DefaultTable(title string, headers []string) *tablewriter.Table

DefaultTable creates a default table with the given title and headers

ExtraStepExecuted

func ExtraStepExecuted(bar *progressbar.ProgressBar) error

FormatDuration

func FormatDuration(d time.Duration) string

FormatDuration returns a user friendly string for a duration

NewUserLog

func NewUserLog(log luxlog.Logger, userwriter io.Writer)

PrintTableEndpoints

func PrintTableEndpoints(clusterInfo *rpcpb.ClusterInfo)

PrintTableEndpoints prints the endpoints coming from the healthy call

PrintWait

func PrintWait(cancel chan struct{})

PrintWait does some dot printing to entertain the user

SpinComplete

func SpinComplete(s *ysmrr.Spinner)

SpinFailWithError

func SpinFailWithError(s *ysmrr.Spinner, txt string, err error)

TimedProgressBar

func TimedProgressBar(
	duration time.Duration,
	title string,
	extraSteps int,
) (*progressbar.ProgressBar, error)

Types

UserLog

func (ul *UserLog) Error(msg string, args ...interface{})
func (ul *UserLog) GreenCheckmarkToUser(msg string, args ...interface{})
func (ul *UserLog) Info(msg string, args ...interface{})
func (ul *UserLog) PrintLineSeparator(msg ...string)
func (ul *UserLog) PrintToUser(msg string, args ...interface{})
func (ul *UserLog) RedXToUser(msg string, args ...interface{})

UserSpinner

func NewUserSpinner() *UserSpinner
func (us *UserSpinner) SpinToUser(msg string, args ...interface{}) *ysmrr.Spinner
func (us *UserSpinner) Stop()