vm

Documentation

Overview

Package vm provides a wrapper around the goja runtime.

Index

• Variables
• type Option
  • func WithStartingLineNumber(lineNumber int) Option
• type Options
• type VM
  • func New() (*VM, error)
  • func (v *VM) Run(ctx context.Context, name string, src string, opts ...Option) (goja.Value, error)
  • func (v *VM) RunFunction(ctx context.Context, fnName string, args ...any) (goja.Value, error)
  • func (v *VM) ToObject(val goja.Value) *goja.Object

Variables

var (
	// ErrCompilation is returned when a script fails to compile.
	ErrCompilation = errors.New("script compilation failed")
	// ErrRuntime is returned when a script fails to run.
	ErrRuntime = errors.New("script runtime failure")
	// ErrFunctionNotFound Function does not exist in script.
	ErrFunctionNotFound = errors.New("failed to find function")
)

Types

type Option

type Option func(*Options)

Option represents an option for running a script.

func WithStartingLineNumber

func WithStartingLineNumber(lineNumber int) Option

WithStartingLineNumber sets the starting line number for the script.

type Options

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

Options represents options for running a script.

type VM

type VM struct {
	*goja.Runtime
	// contains filtered or unexported fields
}

VM is a wrapper around the goja runtime.

func New

func New() (*VM, error)

New creates a new VM.

func (*VM) Run

func (v *VM) Run(ctx context.Context, name string, src string, opts ...Option) (goja.Value, error)

Run runs a script in the VM.

func (*VM) RunFunction

func (v *VM) RunFunction(ctx context.Context, fnName string, args ...any) (goja.Value, error)

RunFunction will run the named function if it already exists within the environment, for example if it was defined in a script run by RunScript. The provided args will be passed to the function, and the result will be returned.

func (*VM) ToObject

func (v *VM) ToObject(val goja.Value) *goja.Object

ToObject converts a value to an object.