output

Documentation

Overview

Package output renders API payloads in user-selected formats (json, yaml, raw, id) with optional --jq filtering. Table rendering is intentionally separate so callers can supply type-specific columns; see RenderTable.

Index

• func Render(w io.Writer, format Format, payload any, opts ...Option) error
• func RenderMarkdownTable(w io.Writer, headers []string, rows [][]string) error
• func RenderTable(w io.Writer, headers []string, rows [][]string) error
• type Format
  • func ParseFormat(s string) (Format, error)
• type Option
  • func WithJQ(expr string) Option
  • func WithPretty(p bool) Option
• type Options

Functions

func Render

func Render(w io.Writer, format Format, payload any, opts ...Option) error

Render formats payload and writes it to w. FormatTable is rejected here because table columns depend on the concrete type; use RenderTable instead.

func RenderMarkdownTable

func RenderMarkdownTable(w io.Writer, headers []string, rows [][]string) error

RenderMarkdownTable writes a GitHub-flavored pipe table: a header row, a `--- | ---` separator, then one row per record. Headers are uppercased to match RenderTable's tabwriter output. Cells are written verbatim; callers should pre-escape any literal `|` characters.

func RenderTable

func RenderTable(w io.Writer, headers []string, rows [][]string) error

Types

type Format

type Format string

const (
	FormatJSON     Format = "json"
	FormatYAML     Format = "yaml"
	FormatRaw      Format = "raw"
	FormatID       Format = "id"
	FormatTable    Format = "table"
	FormatMarkdown Format = "markdown"
)

func ParseFormat

func ParseFormat(s string) (Format, error)

type Option

type Option func(*Options)

func WithJQ

func WithJQ(expr string) Option

func WithPretty

func WithPretty(p bool) Option

type Options

type Options struct {
	JQ     string
	Pretty bool
}