js

Documentation

Overview

Package js is a thin wrapper around Goja runtime.

Because Goja itself doesn't support most of modern JS features, the source code is transpiled by Babel before executing it, so we can actually write state migrations in ES5.1+.

Index

• type Runtime
  • func NewRuntime() *Runtime
  • func (runtime *Runtime) Get(name string) goja.Value
  • func (runtime *Runtime) Script(name string, source string, args ...interface{}) *Script
  • func (runtime *Runtime) Set(name string, val interface{}) error
• type Script
  • func (s *Script) Run(opts ...ScriptOption) (interface{}, error)
• type ScriptOption
  • func TranspileToES5(val bool) ScriptOption

Types

type Runtime

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

func NewRuntime

func NewRuntime() *Runtime

NewRuntime creates a new JavaScript runtime. The runtime is set up to uncapitalize struct fields and methods passed into runtime as objects.

func (*Runtime) Get

func (runtime *Runtime) Get(name string) goja.Value

Get the specified variable in the global context.

func (*Runtime) Script

func (runtime *Runtime) Script(name string, source string, args ...interface{}) *Script

func (*Runtime) Set

func (runtime *Runtime) Set(name string, val interface{}) error

Set the specified variable in the global context.

type Script

type Script struct {
	Name   string
	Source string
	Args   []interface{}
	// contains filtered or unexported fields
}

func (*Script) Run

func (s *Script) Run(opts ...ScriptOption) (interface{}, error)

Run runs a script, and then invokes the function exported by the script ("export default function") with the script's arguments.

type ScriptOption

type ScriptOption func(s *Script) error

func TranspileToES5

func TranspileToES5(val bool) ScriptOption

TranspileToES5 transforms the script source code to ES5.1 using Babel