godef

Documentation

Index

• type HTMLTemplate
  • func NewHTMLTemplate(name, subject, content string, opts ...Option[*htmltemplate.Template]) (*HTMLTemplate, error)
• type Option
  • func WithHTMLPreRender(preRender preRenderFunc) Option[*htmltemplate.Template]
  • func WithHTMLVars(vars map[string]any) Option[*htmltemplate.Template]
  • func WithPreRender[TMPL itmpl](preRender preRenderFunc) Option[TMPL]
  • func WithTextPreRender(preRender preRenderFunc) Option[*texttemplate.Template]
  • func WithTextVars(vars map[string]any) Option[*texttemplate.Template]
  • func WithVars[TMPL itmpl](vars map[string]any) Option[TMPL]
• type Template
  • func (t *Template[TMPL]) IsHTML() bool
  • func (t *Template[TMPL]) Name() string
  • func (t *Template[TMPL]) Render(ctx context.Context, wr io.Writer, params map[string]any) error
  • func (t *Template[TMPL]) Subject(ctx context.Context, vars map[string]any) (string, error)
• type TextTemplate
  • func NewTextTemplate(name, subject, content string, opts ...Option[*texttemplate.Template]) (*TextTemplate, error)

Types

type HTMLTemplate

type HTMLTemplate = Template[*htmltemplate.Template]

func NewHTMLTemplate

func NewHTMLTemplate(name, subject, content string, opts ...Option[*htmltemplate.Template]) (*HTMLTemplate, error)

NewHTMLTemplate returns new template

type Option

type Option[TMPL itmpl] func(*Template[TMPL])

func WithHTMLPreRender

func WithHTMLPreRender(preRender preRenderFunc) Option[*htmltemplate.Template]

func WithHTMLVars

func WithHTMLVars(vars map[string]any) Option[*htmltemplate.Template]

func WithPreRender

func WithPreRender[TMPL itmpl](preRender preRenderFunc) Option[TMPL]

func WithTextPreRender

func WithTextPreRender(preRender preRenderFunc) Option[*texttemplate.Template]

func WithTextVars

func WithTextVars(vars map[string]any) Option[*texttemplate.Template]

func WithVars

func WithVars[TMPL itmpl](vars map[string]any) Option[TMPL]

type Template

type Template[TMPL itmpl] struct {
	// contains filtered or unexported fields
}

Template is the template for the message

func (*Template[TMPL]) IsHTML

func (t *Template[TMPL]) IsHTML() bool

IsHTML returns true if the template is HTML

func (*Template[TMPL]) Name

func (t *Template[TMPL]) Name() string

Name returns the name of the template

func (*Template[TMPL]) Render

func (t *Template[TMPL]) Render(ctx context.Context, wr io.Writer, params map[string]any) error

Render renders the template with the given params

func (*Template[TMPL]) Subject

func (t *Template[TMPL]) Subject(ctx context.Context, vars map[string]any) (string, error)

Subject returns the subject of the template

type TextTemplate

type TextTemplate = Template[*texttemplate.Template]

func NewTextTemplate

func NewTextTemplate(name, subject, content string, opts ...Option[*texttemplate.Template]) (*TextTemplate, error)

NewTextTemplate returns new template