tabify

Documentation

Index

• func JSON(j *jsonmap.Json, opt ...Option) ([]*jsonmap.Json, error)
• func Map(j *jsonmap.Json, opt ...Option) ([]map[string]interface{}, error)
• func Slice(j *jsonmap.Json, opt ...Option) ([][]interface{}, error)
• func Tabify(j *jsonmap.Json, writer TableWriter, opt ...Option) error
• type KeyExcluderFunc
• type KeyFormatterFunc
• type Option
  • func KeyExcluder(v KeyExcluderFunc) Option
  • func KeyFormatter(v KeyFormatterFunc) Option
• type Options
• type TableWriter

Functions

func JSON

func JSON(j *jsonmap.Json, opt ...Option) ([]*jsonmap.Json, error)

JSON to flatten a json

func Map

func Map(j *jsonmap.Json, opt ...Option) ([]map[string]interface{}, error)

Map to tabify into a map array

func Slice

func Slice(j *jsonmap.Json, opt ...Option) ([][]interface{}, error)

Slice to tabify into a slice array. Note : first row contains headers

func Tabify

func Tabify(j *jsonmap.Json, writer TableWriter, opt ...Option) error

Tabify using a custom TableWriter

Types

type KeyExcluderFunc

type KeyExcluderFunc func([]string) bool

KeyExcluderFunc is a function to exclude a key from the input json

type KeyFormatterFunc

type KeyFormatterFunc func([]string) string

KeyFormatterFunc is a function to format a key from the input json

type Option

type Option func(o *Options)

Option is an option setter

func KeyExcluder

func KeyExcluder(v KeyExcluderFunc) Option

KeyExcluder sets the key excluder default : nil

func KeyFormatter

func KeyFormatter(v KeyFormatterFunc) Option

KeyFormatter sets the key formatter default : func (keys []string) => strings.Join(keys, "#")

type Options

type Options struct {
	KeyFormatter KeyFormatterFunc
	KeyExcluder  KeyExcluderFunc
}

Options are our tabify options

type TableWriter

type TableWriter interface {
	OpenRow()
	Cell(k string, v interface{}, deep int)
	CloseRow()
}

TableWriter is an interface to define a table writer