gojs

Documentation

Index

• Variables
• func RegisterFuncWithSignature(runtime *goja.Runtime, opts FuncOpts) error
• type FuncOpts
• type GojaModule
  • func (p *GojaModule) Enable(runtime Runtime)
  • func (p *GojaModule) Name() string
  • func (p *GojaModule) Register() Module
  • func (p *GojaModule) Require(runtime *goja.Runtime, module *goja.Object)
  • func (p *GojaModule) Set(objects Objects) Module
  • func (p *GojaModule) String() string
• type Module
  • func NewGojaModule(name string) Module
• type Object
• type Objects
• type Runtime

Variables

var (
	ErrInvalidFuncOpts = errorutil.NewWithFmt("invalid function options: %v")
)

Functions

func RegisterFuncWithSignature

func RegisterFuncWithSignature(runtime *goja.Runtime, opts FuncOpts) error

RegisterFunc registers a function with given name, signatures and description

Types

type FuncOpts

type FuncOpts struct {
	Name        string
	Signatures  []string
	Description string
	FuncDecl    interface{}
}

type GojaModule

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

func (*GojaModule) Enable

func (p *GojaModule) Enable(runtime Runtime)

func (*GojaModule) Name

func (p *GojaModule) Name() string

func (*GojaModule) Register

func (p *GojaModule) Register() Module

func (*GojaModule) Require

func (p *GojaModule) Require(runtime *goja.Runtime, module *goja.Object)

func (*GojaModule) Set

func (p *GojaModule) Set(objects Objects) Module

func (*GojaModule) String

func (p *GojaModule) String() string

type Module

type Module interface {
	Name() string
	Set(objects Objects) Module
	Enable(Runtime)
	Register() Module
}

func NewGojaModule

func NewGojaModule(name string) Module

type Object

type Object interface {
	Set(string, interface{})
	Get(string) interface{}
}

type Objects

type Objects map[string]interface{}

type Runtime

type Runtime interface {
	Set(string, interface{}) error
}