ansitty

README

ansitty

A go package with utilities to enable ANSI escape sequences on terminal output.

Documentation

Overview

Package ansitty provides a function to enable possibility to use ANSI escape sequences in TTY if possible.

Index

• func Disable(writer io.Writer) bool
• func Enable(writer io.Writer) bool
• func Stderr() *os.File
• func Stdout() *os.File
• func Writer(writer io.Writer) io.Writer

Functions

func Disable

func Disable(writer io.Writer) bool

Disable disables possibility to use ANSI escape sequences in TTY if possible.

func Enable

func Enable(writer io.Writer) bool

Enable enables possibility to use ANSI escape sequences in TTY if possible.

func Stderr

func Stderr() *os.File

Stderr enables possibility to use ANSI escape sequences in TTY if possible to stderr and returns os.Stderr.

func Stdout

func Stdout() *os.File

Stdout enables possibility to use ANSI escape sequences in TTY if possible to stdout and returns os.Stdout.

func Writer

func Writer(writer io.Writer) io.Writer

Writer is a convenience function to enable possibility to use ANSI escape sequences in TTY if possible to writer. It calls Enable on the given writer and returns the same writer.