js

Documentation

Index

• Variables
• func Base64() *_base64
• func JSON() *_json
• func WithConsole(s *Command)
• type Command
  • func NewScript(mainFunc string, options ...OptFunc) (cmd *Command)
  • func (s *Command) AddFunc(f ...VMFunc)
  • func (s *Command) Run(scriptSource string) (result *CommandResult, err error)
• type CommandError
  • func (e *CommandError) Error() string
  • func (e *CommandError) ExitCode() int
  • func (e *CommandError) Unwrap() error
• type CommandResult
• type JSConsole
  • func Console() *JSConsole
• type OptFunc
  • func WithGlobal(key string, value any) OptFunc
  • func WithGlobals(globals map[string]any) OptFunc
  • func WithVM(vm *goja.Runtime) OptFunc
• type VMFunc

Variables

var (
	ErrExitCode    = errors.New("script returned with non-zero exit code")
	ErrMainMissing = errors.New("main function not found")
	ErrMainInvalid = errors.New("main function is invalid")
)

var PanicOnError = false

Functions

func Base64

func Base64() *_base64

func JSON

func JSON() *_json

func WithConsole

func WithConsole(s *Command)

Types

type Command

type Command struct {
	// The name of the main function to run.
	Main string
	// contains filtered or unexported fields
}

func NewScript

func NewScript(mainFunc string, options ...OptFunc) (cmd *Command)

func (*Command) AddFunc

func (s *Command) AddFunc(f ...VMFunc)

func (*Command) Run

func (s *Command) Run(scriptSource string) (result *CommandResult, err error)

type CommandError

type CommandError struct {
	Importance int
	Message    string
	Wrapped    error
}

func (*CommandError) Error

func (e *CommandError) Error() string

func (*CommandError) ExitCode

func (e *CommandError) ExitCode() int

func (*CommandError) Unwrap

func (e *CommandError) Unwrap() error

type CommandResult

type CommandResult struct {
	Importance int    `json:"importance"`
	Message    string `json:"message"`
}

type JSConsole

type JSConsole struct {
	Debug func(...any) `json:"debug"`
	Log   func(...any) `json:"log"`
	Info  func(...any) `json:"info"`
	Warn  func(...any) `json:"warn"`
	Error func(...any) `json:"error"`
	Fatal func(...any) `json:"fatal"`
}

func Console

func Console() *JSConsole

type OptFunc

type OptFunc func(*Command)

func WithGlobal

func WithGlobal(key string, value any) OptFunc

func WithGlobals

func WithGlobals(globals map[string]any) OptFunc

func WithVM

func WithVM(vm *goja.Runtime) OptFunc

type VMFunc

type VMFunc func(*goja.Runtime) error