timplit

Documentation

Index

• func Execute(templateText []byte, d *Data) ([]byte, error)
• func ExecuteJSON(templateText []byte, jsonText []byte) ([]byte, error)
• func ExecuteYAML(templateText []byte, yamlText []byte) ([]byte, error)
• type Data
• type Timplit
  • func (t *Timplit) JSON() error
  • func (t *Timplit) MultipartJSON() error
  • func (t *Timplit) YAML() error

Functions

func Execute

func Execute(templateText []byte, d *Data) ([]byte, error)

Execute applies the data to the template.

func ExecuteJSON

func ExecuteJSON(templateText []byte, jsonText []byte) ([]byte, error)

ExecuteJSON applies the raw JSON text to the template.

func ExecuteYAML

func ExecuteYAML(templateText []byte, yamlText []byte) ([]byte, error)

ExecuteYAML applies the raw YAML text (a single document) to the template.

Types

type Data

type Data interface{}

Data is the JSON/YAML will be unmarshaled into this type, then applied to the template.

type Timplit

type Timplit struct {
	Template          io.Reader
	Data              io.Reader
	Out               io.Writer
	Err               io.Writer
	IgnoreParseErrors bool
}

func (*Timplit) JSON

func (t *Timplit) JSON() error

JSON reads a single JSON document from an io.Reader (usually stdin) until EOF, executes the template, and writes the result to an io.Writer (usually stdout). The template is always read first in full, and blocks until EOF is reached.

If t.IgnoreParseErrors is true, then errors will be printed but execution will continue. Otherwise, the first error encountered is returned and subsequent lines will not be read.

func (*Timplit) MultipartJSON

func (t *Timplit) MultipartJSON() error

MultipartJSON reads one JSON document per line from an io.Reader (usually stdin), executes the template for each line, and writes the result to an io.Writer (usually stdout). The template is always read first in full, and blocks until EOF is reached.

If t.IgnoreParseErrors is true, then errors will be printed but execution will continue. Otherwise, the first error encountered is returned and subsequent lines will not be read.

func (*Timplit) YAML

func (t *Timplit) YAML() error

YAML executes the template for each YAML document (separated by "---") it reads from an io.Reader (usually stdin) and writes the result to an io.Writer (usually stdout). The template is always read first in full, and blocks until EOF is reached.

If t.IgnoreParseErrors is true, then errors will be printed but execution will continue. Otherwise, the first error encountered is returned and subsequent lines will not be read.