humanwriter

Documentation

Index

• type HumanResultWriter
  • func New(out io.Writer, opts ...Option) *HumanResultWriter
  • func (w *HumanResultWriter) WriteResult(result *api.CheckResult) error
• type Option
  • func WithColors(colors bool) Option
  • func WithMode(mode OutputMode) Option
• type OutputMode
  • func (m OutputMode) String() string

Types

type HumanResultWriter

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

func New

func New(out io.Writer, opts ...Option) *HumanResultWriter

func (*HumanResultWriter) WriteResult

func (w *HumanResultWriter) WriteResult(result *api.CheckResult) error

type Option

type Option func(w *HumanResultWriter)

func WithColors

func WithColors(colors bool) Option

func WithMode

func WithMode(mode OutputMode) Option

type OutputMode

type OutputMode int

const (
	// OutputModeTest causes the writer to prepend a plain-text
	// description of the check result (PASS, FAIL, SKIP, etc)
	OutputModeText OutputMode = iota

	// OutputModeEmoji causes the writer to prepend an emoji
	// describing the check result.
	OutputModeEmoji
)

func (OutputMode) String

func (m OutputMode) String() string