output

Documentation

Overview

Package output provides JSON and NDJSON serialization for items.

Index

• type Format
  • func ParseFormat(s string) Format
• type Writer
  • func New(w io.Writer, format Format) *Writer
  • func (w *Writer) Write(items []model.Item) error

Types

type Format

type Format string

Format represents the output format.

const (
	FormatJSON   Format = "json"
	FormatNDJSON Format = "ndjson"
)

func ParseFormat

func ParseFormat(s string) Format

ParseFormat parses a format string.

type Writer

type Writer struct {
	// contains filtered or unexported fields
}

Writer outputs items in the specified format.

func New

func New(w io.Writer, format Format) *Writer

New creates a new Writer.

func (*Writer) Write

func (w *Writer) Write(items []model.Item) error

Write outputs all items in the configured format.