engine

Documentation

Index

• Variables
• type Engine
  • func New(cfg *config.Config, option ...Option) (Engine, error)
• type Option
  • func IgnoreNotFound(b bool) Option
  • func TextType(tto TextTypeOpt) Option
• type TextTypeOpt

Variables

var (
	ErrRendering = errors.New("failed to render")
)

Types

type Engine

type Engine interface {
	Render(ctx context.Context, text string, dest io.Writer) error
}

Engine is a template engine.

func New

func New(cfg *config.Config, option ...Option) (Engine, error)

type Option

type Option func(*opts)

Option is configurable Engine behavior.

func IgnoreNotFound

func IgnoreNotFound(b bool) Option

IgnoreNotFound ignores values are not found in the external store.

func TextType

func TextType(tto TextTypeOpt) Option

TextType sets the text type of rendered text.

type TextTypeOpt

type TextTypeOpt = encoding.TextType

const (
	TextTypePlain     TextTypeOpt = "plain"
	TextTypeJSON      TextTypeOpt = encoding.TextTypeJSON
	TextTypeJSONArray TextTypeOpt = encoding.TextTypeJSONArray
	TextTypeYAML      TextTypeOpt = encoding.TextTypeYAML
	TextTypeYAMLArray TextTypeOpt = encoding.TextTypeYAMLArray
	TextTypeYAMLDocs  TextTypeOpt = encoding.TextTypeYAMLDocs
)