v8host

Documentation

Overview

The v8host packages provides functionality to execute client-side scripts in gost-dom. The engine uses v8, and requires cgo.

This engine is based on tommie's v8go form, which automatically pulls the latest v8 changes from the chromium repo.

An alternate script engine that is implemented in pure go is found in the gojahost package

See also: https://github.com/tommie/v8go

Index

• Variables
• func Shutdown()
• type HostOption
  • func WithLogger(logger log.Logger) HostOption
• type Keys
  • func (k Keys[K, V]) All() iter.Seq[K]
• type MutationCallback
  • func (cb MutationCallback) HandleMutation(recs []mutation.Record, obs *mutation.Observer)
• type V8Script
  • func (s V8Script) Eval() (any, error)
  • func (s V8Script) Run() error
• type V8ScriptContext
  • func (ctx *V8ScriptContext) Clock() html.Clock
  • func (ctx *V8ScriptContext) Close()
  • func (ctx *V8ScriptContext) Compile(script string) (V8Script, error)
  • func (ctx *V8ScriptContext) Eval(script string) (any, error)
  • func (ctx *V8ScriptContext) Run(script string) error
• type V8ScriptHost
  • func New(opts ...HostOption) *V8ScriptHost
  • func (host *V8ScriptHost) Close()
  • func (host *V8ScriptHost) Logger() log.Logger
  • func (host *V8ScriptHost) NewContext(w html.Window) html.ScriptContext

Variables

var (
	ErrIncompatibleType   = errors.New("Incompatible type")
	ErrWrongNoOfArguments = errors.New("Not enough arguments passed")
)

var MAX_POOL_SIZE = runtime.NumCPU() * 2

MAX_POOL_SIZE sets a limit to the number of script hosts that will be pooled for reuse. By default Go will run as many tests in parallel as you have CPU cores, so there shouldn't be a reason for a larger pool, but this provides a bit of flexibility.

Functions

func Shutdown

func Shutdown()

Dispose all pooled isolates

Types

type HostOption

type HostOption func(o *hostOptions)

func WithLogger

func WithLogger(logger log.Logger) HostOption

type Keys

type Keys[K, V any] struct {
	// contains filtered or unexported fields
}

func (Keys[K, V]) All

func (k Keys[K, V]) All() iter.Seq[K]

type MutationCallback

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

func (MutationCallback) HandleMutation

func (cb MutationCallback) HandleMutation(recs []mutation.Record, obs *mutation.Observer)

type V8Script

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

func (V8Script) Eval

func (s V8Script) Eval() (any, error)

func (V8Script) Run

func (s V8Script) Run() error

type V8ScriptContext

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

func (*V8ScriptContext) Clock

func (ctx *V8ScriptContext) Clock() html.Clock

func (*V8ScriptContext) Close

func (ctx *V8ScriptContext) Close()

func (*V8ScriptContext) Compile

func (ctx *V8ScriptContext) Compile(script string) (V8Script, error)

func (*V8ScriptContext) Eval

func (ctx *V8ScriptContext) Eval(script string) (any, error)

func (*V8ScriptContext) Run

func (ctx *V8ScriptContext) Run(script string) error

type V8ScriptHost

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

func New

func New(opts ...HostOption) *V8ScriptHost

func (*V8ScriptHost) Close

func (host *V8ScriptHost) Close()

Close informs that client code is done using this script host. The host will be placed into a pool;

func (*V8ScriptHost) Logger

func (host *V8ScriptHost) Logger() log.Logger

func (*V8ScriptHost) NewContext

func (host *V8ScriptHost) NewContext(w html.Window) html.ScriptContext

NewContext creates a new script context using w as the global window object. Calling with a nil value for w is allowed, but not supported; and any attempt to access the DOM will result in a runtime error.