template

package
v0.1.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jul 10, 2026 License: MIT Imports: 13 Imported by: 0

Documentation

Overview

Package template exposes Go text/template and html/template rendering helpers as Go-backed objects suitable for goja JavaScript runtimes.

Index

Constants

View Source
const (
	MissingKeyDefault = "default"
	MissingKeyInvalid = "invalid"
	MissingKeyZero    = "zero"
	MissingKeyError   = "error"
)

Variables

This section is empty.

Functions

This section is empty.

Types

type Mode

type Mode string
const (
	ModeText Mode = "text"
	ModeHTML Mode = "html"
)

type RenderResult

type RenderResult struct {
	Text         string `json:"text"`
	TemplateName string `json:"templateName"`
	Mode         Mode   `json:"mode"`
	Bytes        int    `json:"bytes"`
}

func RenderHTML

func RenderHTML(source string, data any) (*RenderResult, error)

func RenderText

func RenderText(source string, data any) (*RenderResult, error)

type TemplateBuilder

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

func NewHTMLBuilder

func NewHTMLBuilder() *TemplateBuilder

func NewTextBuilder

func NewTextBuilder() *TemplateBuilder

func (*TemplateBuilder) BuildConfig

func (b *TemplateBuilder) BuildConfig() (*TemplateConfig, error)

func (*TemplateBuilder) Delims

func (b *TemplateBuilder) Delims(left, right string) *TemplateBuilder

func (*TemplateBuilder) Funcs

func (b *TemplateBuilder) Funcs(names ...string) *TemplateBuilder

func (*TemplateBuilder) JSFunc

func (b *TemplateBuilder) JSFunc(name string, value goja.Value) *TemplateBuilder

JSFunc registers a JavaScript function as a Go template helper.

The wrapper is synchronous: the JavaScript function is called while the template executes. Returned JavaScript values are exported back to Go before text/template or html/template receives them. In HTML mode, ordinary returned strings remain untrusted strings and are escaped by html/template.

func (*TemplateBuilder) MissingKey

func (b *TemplateBuilder) MissingKey(policy string) *TemplateBuilder

func (*TemplateBuilder) Name

func (b *TemplateBuilder) Name(name string) *TemplateBuilder

func (*TemplateBuilder) Parse

func (b *TemplateBuilder) Parse(source string) (*TemplateSet, error)

func (*TemplateBuilder) ParseNamed

func (b *TemplateBuilder) ParseNamed(name, source string) (*TemplateSet, error)

func (*TemplateBuilder) Validate

func (b *TemplateBuilder) Validate() ValidationResult

type TemplateConfig

type TemplateConfig struct {
	Mode       Mode     `json:"mode"`
	Name       string   `json:"name"`
	FuncSets   []string `json:"funcSets,omitempty"`
	MissingKey string   `json:"missingKey"`
	LeftDelim  string   `json:"leftDelim,omitempty"`
	RightDelim string   `json:"rightDelim,omitempty"`
}

type TemplateInfo

type TemplateInfo struct {
	Name    string `json:"name"`
	Defined bool   `json:"defined"`
	Mode    Mode   `json:"mode"`
}

type TemplateSet

type TemplateSet struct {
	Mode Mode
	Name string
	// contains filtered or unexported fields
}

func (*TemplateSet) Lookup

func (s *TemplateSet) Lookup(name string) *TemplateInfo

func (*TemplateSet) Render

func (s *TemplateSet) Render(data any) (*RenderResult, error)

func (*TemplateSet) RenderString

func (s *TemplateSet) RenderString(data any) (string, error)

func (*TemplateSet) RenderTemplate

func (s *TemplateSet) RenderTemplate(name string, data any) (*RenderResult, error)

func (*TemplateSet) Templates

func (s *TemplateSet) Templates() []TemplateInfo

type ValidationResult

type ValidationResult struct {
	Valid  bool     `json:"valid"`
	Errors []string `json:"errors,omitempty"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
⌂ 换网址