jz

README

jz

JavaScript / TypeScript ES6 Virtual Machine in pure Go. Based on:

• https://github.com/dop251/goja
• https://github.com/dop251/goja_nodejs
• https://github.com/jvatic/goja-babel

Example

cmd/example1/main.go

package main

import (
  "github.com/andrylavr/jz"
  "log"
)
import _ "embed"

//go:embed example1.js
var example1 string

func main() {
  vm := jz.New()
  vm.ImportMap["three"] = "https://threejs.org/build/three.js"
  vm.ImportMap["three/addons/"] = "https://threejs.org/examples/jsm/"

  _, err := vm.RunScript("example1.js", example1)
  if err != nil {
    log.Println(err)
  }
}

See more docs here: https://github.com/dop251/goja

Documentation

Index

• func GetContent(url string) (string, error)
• type Cacher
• type Console
  • func (console *Console) Error(args ...interface{})
  • func (console *Console) Info(args ...interface{})
  • func (console *Console) Log(args ...interface{})
  • func (console *Console) Warn(args ...interface{})
• type FSCacher
  • func (t FSCacher) Exists(key string) bool
  • func (t FSCacher) Get(key string) string
  • func (t FSCacher) Save(key string, content string)
• type ImportMap
• type JSModule
• type Module
  • func (m *Module) Require(name string) Value
• type ModuleCache
• type Object
• type Require
• type Runtime
  • func New() *Runtime
  • func (r *Runtime) AddImportMap(m ImportMap)
  • func (r *Runtime) ClearImportMap()
  • func (r *Runtime) RunFile(filename string) (Value, error)
  • func (r *Runtime) RunScript(name, src string) (Value, error)
  • func (r *Runtime) RunString(str string) (Value, error)
  • func (r *Runtime) Transform(src string) (string, error)
• type Value
  • func NewConsole(vm *Runtime) Value
  • func NewRequire(vm *Runtime) Value

Functions

func GetContent

func GetContent(url string) (string, error)

Types

type Cacher

type Cacher interface {
	Exists(key string) bool
	Get(key string) string
	Save(key string, s string)
}

type Console

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

func (*Console) Error

func (console *Console) Error(args ...interface{})

func (*Console) Info

func (console *Console) Info(args ...interface{})

func (*Console) Log

func (console *Console) Log(args ...interface{})

func (*Console) Warn

func (console *Console) Warn(args ...interface{})

type FSCacher

type FSCacher struct {
	Dir string
}

func (FSCacher) Exists

func (t FSCacher) Exists(key string) bool

func (FSCacher) Get

func (t FSCacher) Get(key string) string

func (FSCacher) Save

func (t FSCacher) Save(key string, content string)

type ImportMap

type ImportMap map[string]string

type JSModule

type JSModule = *Object

type Module

type Module struct {
	Exports *Object
	// contains filtered or unexported fields
}

func (*Module) Require

func (m *Module) Require(name string) Value

type ModuleCache

type ModuleCache map[string][]byte

type Object

type Object = goja.Object

type Require

type Require struct {
	sync.Mutex
	// contains filtered or unexported fields
}

type Runtime

type Runtime struct {
	*goja.Runtime
	UseBabel      bool
	UseTypeScript bool
	ImportMap
	//require         *Require
	TransformCacher Cacher
	ContentCacher   Cacher
}

func New

func New() *Runtime

func (*Runtime) AddImportMap

func (r *Runtime) AddImportMap(m ImportMap)

func (*Runtime) ClearImportMap

func (r *Runtime) ClearImportMap()

func (*Runtime) RunFile

func (r *Runtime) RunFile(filename string) (Value, error)

func (*Runtime) RunScript

func (r *Runtime) RunScript(name, src string) (Value, error)

func (*Runtime) RunString

func (r *Runtime) RunString(str string) (Value, error)

RunString executes the given string in the global context.

func (*Runtime) Transform

func (r *Runtime) Transform(src string) (string, error)

Transform transforms src from ES6|TS to ES5

type Value

type Value = goja.Value

func NewConsole

func NewConsole(vm *Runtime) Value

func NewRequire

func NewRequire(vm *Runtime) Value