wordwrap

Documentation

Index

• type Options
• type Wrapper
  • func New(opts ...func(*Options)) Wrapper

Types

type Options

type Options struct {
	FixedMaxWidth              int    // FixedMaxWidth maximum width of line / length at which newline should be inserted
	DynamicMaxWidth            bool   // DynamicMaxWidth if true, detect terminal max width before every wrap
	Padding                    string // Padding string to pad wrapped lines with. Eg. "  " for 2-space indent
	EscapeNewlineStringLiteral bool   // EscapeNewlineStringLiteral For `"long strings like this"`, indicates whether inserted newlines should be prefixed with ` \`
}

Options options for a word wrapper

type Wrapper

type Wrapper interface {
	WrapTo(s string, maxWidth int) string
	Wrap(s string) string
}

func New

func New(opts ...func(*Options)) Wrapper