output

package

v0.3.0 Latest Latest Go to latest Published: Mar 28, 2024 License: Apache-2.0 Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Package output handles functions relating to displaying the final output

This section is empty.

This section is empty.

func Display(data any) error

Display will decorate the output if possible. Otherwise, will print out the standard JSON.

type EmptyStruct struct{}

EmptyStruct is used when we wish to return an empty object.

type Printer interface {
	DisplayNoColor(data any) error
	DisplayColor(data any) error
}

Printer is a content type agnostic interface for displaying data.

type UniPrinter struct {
	Colorful bool
	Printer  Printer
}

UniPrinter is a universal printer that can handle different output formats.

func NewUniPrinter(outputFormat string) *UniPrinter

NewUniPrinter creates a new UniPrinter based on the specified output format and optional functional options.

func (prt UniPrinter) Display(data any) error

Display prints the data using the configured printer and color settings.