jst

Documentation

Index

• Variables
• func CreateDefaultExtensions(lateBind bool) []commonjs.Extension
• func CreateScriptletExtension(jsContext *commonjs.Context) any
• func NewDefaultEnvironment(log commonlog.Logger, urlContext *exturl.Context, basePaths ...exturl.URL) *commonjs.Environment
• func Precompile(url exturl.URL, script string, jsContext *commonjs.Context) (string, error)
• func Present(environment *commonjs.Environment, object *goja.Object, writer io.Writer, ...) error
• func RegisterDefaultRenderers()
• func RegisterSugar(prefix string, handle HandleSugarFunc)
• func RenderJST(writer io.Writer, content any, js bool, jsContext *commonjs.Context) error
• func RequireAndPresent(environment *commonjs.Environment, id string, writer io.Writer, ...) error
• func RequireAndPresentString(environment *commonjs.Environment, id string, variables ard.StringMap) (string, error)
• func UnwrapWriters(writer io.Writer) (io.Writer, error)
• type CaptureWriter
  • func NewCaptureWriter(originalWriter io.Writer, name string, onCaptured CapturedFunc) *CaptureWriter
  • func (self *CaptureWriter) Close() error
  • func (self *CaptureWriter) GetWrappedWriter() io.Writer
  • func (self *CaptureWriter) Write(b []byte) (int, error)
  • func (self *CaptureWriter) WriteByte(c byte) error
  • func (self *CaptureWriter) WriteString(s string) (int, error)
• type CapturedFunc
• type Context
  • func NewContext(writer io.Writer, variables ard.StringMap) *Context
  • func (self *Context) Clone() *Context
  • func (self *Context) Embed(present any, jsContext *commonjs.Context) error
  • func (self *Context) EndCapture() error
  • func (self *Context) EndRender() error
  • func (self *Context) Flush() error
  • func (self *Context) GetVariable(keys ...any) any
  • func (self *Context) StartCapture(name string)
  • func (self *Context) StartRender(renderer string, jsContext *commonjs.Context) error
  • func (self *Context) Write(content any) error
• type HandleSugarFunc
• type RenderWriter
  • func NewRenderWriter(originalWriter io.Writer, context *commonjs.Context, renderer string) (*RenderWriter, error)
  • func (self *RenderWriter) Close() error
  • func (self *RenderWriter) GetWrappedWriter() io.Writer
  • func (self *RenderWriter) Write(b []byte) (int, error)
  • func (self *RenderWriter) WriteByte(c byte) error
  • func (self *RenderWriter) WriteString(s string) (int, error)
• type ScriptletAPI
  • func NewScriptletAPI(jsContext *commonjs.Context) *ScriptletAPI
  • func (self *ScriptletAPI) Render(writer io.Writer, content any, renderer string, timeoutSeconds float64) error
  • func (self *ScriptletAPI) RenderFrom(writer io.Writer, id string, renderer string, timeoutSeconds float64) error
  • func (self *ScriptletAPI) RenderToString(content any, renderer string) (string, error)
• type ScriptletContext
  • func NewScriptletContext(writer io.Writer) *ScriptletContext
  • func (self *ScriptletContext) AsContextWrite(literal string) error
  • func (self *ScriptletContext) NextSuffix() string
  • func (self *ScriptletContext) WriteString(content string) error
• type WrappingWriter

Variables

var DebugWriter io.Writer

Functions

func CreateDefaultExtensions

func CreateDefaultExtensions(lateBind bool) []commonjs.Extension

func CreateScriptletExtension

func CreateScriptletExtension(jsContext *commonjs.Context) any

(commonjs.CreateExtensionFunc signature)

func NewDefaultEnvironment

func NewDefaultEnvironment(log commonlog.Logger, urlContext *exturl.Context, basePaths ...exturl.URL) *commonjs.Environment

func Precompile

func Precompile(url exturl.URL, script string, jsContext *commonjs.Context) (string, error)

(commonjs.PrecompileFunc signature)

func Present

func Present(environment *commonjs.Environment, object *goja.Object, writer io.Writer, variables ard.StringMap) error

func RegisterDefaultRenderers

func RegisterDefaultRenderers()

func RegisterSugar

func RegisterSugar(prefix string, handle HandleSugarFunc)

func RenderJST

func RenderJST(writer io.Writer, content any, js bool, jsContext *commonjs.Context) error

([scriptlet.RenderFunc] signature)

func RequireAndPresent

func RequireAndPresent(environment *commonjs.Environment, id string, writer io.Writer, variables ard.StringMap) error

func RequireAndPresentString

func RequireAndPresentString(environment *commonjs.Environment, id string, variables ard.StringMap) (string, error)

func UnwrapWriters

func UnwrapWriters(writer io.Writer) (io.Writer, error)

Types

type CaptureWriter

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

func NewCaptureWriter

func NewCaptureWriter(originalWriter io.Writer, name string, onCaptured CapturedFunc) *CaptureWriter

func (*CaptureWriter) Close

func (self *CaptureWriter) Close() error

(io.Closer interface)

func (*CaptureWriter) GetWrappedWriter

func (self *CaptureWriter) GetWrappedWriter() io.Writer

(WrappingWriter interface)

func (*CaptureWriter) Write

func (self *CaptureWriter) Write(b []byte) (int, error)

(io.Writer interface)

func (*CaptureWriter) WriteByte

func (self *CaptureWriter) WriteByte(c byte) error

io.ByteWriter interface

func (*CaptureWriter) WriteString

func (self *CaptureWriter) WriteString(s string) (int, error)

io.StringWriter interface

type CapturedFunc

type CapturedFunc func(name string, value string)

type Context

type Context struct {
	Variables ard.StringMap
	Writer    io.Writer
}

func NewContext

func NewContext(writer io.Writer, variables ard.StringMap) *Context

Note: the expectation is that the writer is not asynchronous. See [WriteString].

func (*Context) Clone

func (self *Context) Clone() *Context

func (*Context) Embed

func (self *Context) Embed(present any, jsContext *commonjs.Context) error

func (*Context) EndCapture

func (self *Context) EndCapture() error

func (*Context) EndRender

func (self *Context) EndRender() error

func (*Context) Flush

func (self *Context) Flush() error

func (*Context) GetVariable

func (self *Context) GetVariable(keys ...any) any

func (*Context) StartCapture

func (self *Context) StartCapture(name string)

func (*Context) StartRender

func (self *Context) StartRender(renderer string, jsContext *commonjs.Context) error

func (*Context) Write

func (self *Context) Write(content any) error

type HandleSugarFunc

type HandleSugarFunc func(scriptletContext *ScriptletContext, prefix string, code string) (bool, error) // return true to allow trailing newlines

type RenderWriter

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

func NewRenderWriter

func NewRenderWriter(originalWriter io.Writer, context *commonjs.Context, renderer string) (*RenderWriter, error)

func (*RenderWriter) Close

func (self *RenderWriter) Close() error

(io.Closer interface)

func (*RenderWriter) GetWrappedWriter

func (self *RenderWriter) GetWrappedWriter() io.Writer

(WrappingWriter interface)

func (*RenderWriter) Write

func (self *RenderWriter) Write(b []byte) (int, error)

(io.Writer interface)

func (*RenderWriter) WriteByte

func (self *RenderWriter) WriteByte(c byte) error

io.ByteWriter interface

func (*RenderWriter) WriteString

func (self *RenderWriter) WriteString(s string) (int, error)

io.StringWriter interface

type ScriptletAPI

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

func NewScriptletAPI

func NewScriptletAPI(jsContext *commonjs.Context) *ScriptletAPI

func (*ScriptletAPI) Render

func (self *ScriptletAPI) Render(writer io.Writer, content any, renderer string, timeoutSeconds float64) error

func (*ScriptletAPI) RenderFrom

func (self *ScriptletAPI) RenderFrom(writer io.Writer, id string, renderer string, timeoutSeconds float64) error

func (*ScriptletAPI) RenderToString

func (self *ScriptletAPI) RenderToString(content any, renderer string) (string, error)

type ScriptletContext

type ScriptletContext struct {
	Writer io.Writer
	// contains filtered or unexported fields
}

func NewScriptletContext

func NewScriptletContext(writer io.Writer) *ScriptletContext

func (*ScriptletContext) AsContextWrite

func (self *ScriptletContext) AsContextWrite(literal string) error

func (*ScriptletContext) NextSuffix

func (self *ScriptletContext) NextSuffix() string

func (*ScriptletContext) WriteString

func (self *ScriptletContext) WriteString(content string) error

type WrappingWriter

type WrappingWriter interface {
	io.WriteCloser

	GetWrappedWriter() io.Writer
}