node

Documentation

Index

• Constants
• func GetConsoleSize(ctx context.Context, attach api.AttachIO) *[2]uint
• func GetTerminalType() string
• func HandleTerminalResizing(ctx context.Context, attach api.AttachIO, resizeFunc func(api.TermSize) error)
• type ExecIO
  • func DiscardingExecIO() *ExecIO
  • func NewExecIO(tty bool, stdin io.Reader, stdout, stderr io.WriteCloser, ...) *ExecIO
  • func (e *ExecIO) Resize() <-chan api.TermSize
  • func (e *ExecIO) Stderr() io.WriteCloser
  • func (e *ExecIO) Stdin() io.Reader
  • func (e *ExecIO) Stdout() io.WriteCloser
  • func (e *ExecIO) TTY() bool

Constants

const (
	DefaultTerminalType = "xterm-256color"

	DefaultTermWidth  = 60
	DefaultTermHeight = 120

	EnvVarTermType = "TERM"
)

Functions

func GetConsoleSize

func GetConsoleSize(ctx context.Context, attach api.AttachIO) *[2]uint

GetConsoleSize returns the console size for terminal attachment.

func GetTerminalType

func GetTerminalType() string

GetTerminalType retrieves the terminal type from the environment variables.

func HandleTerminalResizing

func HandleTerminalResizing(ctx context.Context, attach api.AttachIO, resizeFunc func(api.TermSize) error)

HandleTerminalResizing listens for terminal resize events and adjusts accordingly using the provided resizeFunc.

Types

type ExecIO

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

ExecIO implements the api.AttachIO interface and holds the I/O streams and resize channel.

func DiscardingExecIO

func DiscardingExecIO() *ExecIO

DiscardingExecIO creates a new ExecIO with stdout set to discard all data. nolint: ireturn

func NewExecIO

func NewExecIO(tty bool, stdin io.Reader, stdout, stderr io.WriteCloser, chResize chan api.TermSize) *ExecIO

NewExecIO creates a new ExecIO with the given I/O streams and resize channel.

func (*ExecIO) Resize

func (e *ExecIO) Resize() <-chan api.TermSize

Resize returns the resize channel.

func (*ExecIO) Stderr

func (e *ExecIO) Stderr() io.WriteCloser

Stderr returns the stderr writer.

func (*ExecIO) Stdin

func (e *ExecIO) Stdin() io.Reader

Stdin returns the stdin reader.

func (*ExecIO) Stdout

func (e *ExecIO) Stdout() io.WriteCloser

Stdout returns the stdout writer.

func (*ExecIO) TTY

func (e *ExecIO) TTY() bool

TTY returns whether the terminal is a TTY.