format

Documentation

Overview

Package formatters houses the build-in formatter functions that are registered with please

Index

• Constants
• func Bash(in interface{}) (string, error)
• func Dot(in interface{}) (string, error)
• func Json(in interface{}) (string, error)
• func Names() []string
• func Query(in interface{}) (string, error)
• func Register(name string, formatter Formatter) error
• func Xml(in interface{}) (string, error)
• func Yaml(in interface{}) (string, error)
• type Formatter
  • func Get(name string) (Formatter, error)

Constants

const INDENT = "  "

Functions

func Bash

func Bash(in interface{}) (string, error)

func Dot

func Dot(in interface{}) (string, error)

func Json

func Json(in interface{}) (string, error)

func Names

func Names() []string

Names returns a sorted list of valid options for the "format" parameter of Format

func Query

func Query(in interface{}) (string, error)

func Register

func Register(name string, formatter Formatter) error

Register assigns a Formatter function to a name. If the name has already been registered, an error will be returned.

func Xml

func Xml(in interface{}) (string, error)

func Yaml

func Yaml(in interface{}) (string, error)

Types

type Formatter

type Formatter func(interface{}) (string, error)

Type Formatter is a function that takes an interface{} and attempts to format it as a string

func Get

func Get(name string) (Formatter, error)

Get returns a Formatter function by name. If the named formatter is not found, an error will be returned.