output

package
v0.1.0 Latest Latest
Warning

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

Go to latest
Published: Apr 24, 2026 License: MIT Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Pretty

func Pretty(data any) string

func Render

func Render(w io.Writer, opts Options, result Result) error

func RenderError

func RenderError(w io.Writer, opts Options, message string) error

Types

type Breadcrumb struct {
	Action string `json:"action"`
	Cmd    string `json:"cmd"`
}

type Envelope

type Envelope struct {
	OK          bool         `json:"ok"`
	Data        any          `json:"data,omitempty"`
	Summary     string       `json:"summary,omitempty"`
	Breadcrumbs []Breadcrumb `json:"breadcrumbs,omitempty"`
}

type ErrorEnvelope

type ErrorEnvelope struct {
	OK    bool   `json:"ok"`
	Error string `json:"error"`
}

type Options

type Options struct {
	JSON       bool
	Quiet      bool
	IsTerminal bool
}

type Result

type Result struct {
	Data        any
	Summary     string
	Breadcrumbs []Breadcrumb
	Human       string
}

Jump to

Keyboard shortcuts

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