formatter

Documentation

Overview

Package formatter provide types and methods used to convert the results into a custom output (Yaml, Json, etc)

Index

• type Formatter
  • func NewFormatter(t string) Formatter
  • func NewFormatterWithError(t string) (Formatter, error)

Types

type Formatter

type Formatter interface {
	Output(results results.Result) ([]byte, error)
}

Formatter defines the behavior for a Formatter

func NewFormatter

func NewFormatter(t string) Formatter

NewFormatter returns a new instance of formatter

func NewFormatterWithError

func NewFormatterWithError(t string) (Formatter, error)

NewFormatterWithError returns a formatter or an error that can be returned by the formatter instance or in case the formatter is invalid