README
¶
go-quickjs, make quickjs be embedded easily
QuickJS is a small and embeddable Javascript engine written by Fabrice Bellard.
go-quickjs is a package wrapping quickjs and making it a pragmatic embedding language.
With some helper functions provided by go-quickjs, calling Golang functions from Javascript,
or calling Javascript functions from Golang are both very simple. So, with the help of go-quickjs, quickjs
can be embedded in Golang application easily.
Install
To install go-quickjs, following the steps (under Linux/macos):
- make sure
gcc,make,wgetare ready - run
git clone github.com/rosbit/go-quickjsto clone the source cd go-quickjsto change the directory- run
maketo build thelibquickjs.a - optionally run
go build.
Usage
1. Evaluates expressions
package main
import (
"github.com/rosbit/go-quickjs"
"fmt"
)
func main() {
ctx, err := quickjs.NewContext()
if err != nil {
fmt.Printf("%v\n", err)
return
}
defer ctx.Free()
res, _ := ctx.Eval("a + b", map[string]interface{}{
"a": 10,
"b": 1,
})
fmt.Println("result is:", res)
}
2. Go calls Javascript function
Suppose there's a Javascript file named a.js like this:
function add(a, b) {
return a+b
}
one can call the Javascript function add() in Go code like the following:
package main
import (
"github.com/rosbit/go-quickjs"
"fmt"
)
var add func(int, int)int
func main() {
ctx, err := quickjs.NewContext()
if err != nil {
fmt.Printf("%v\n", err)
return
}
defer ctx.Free()
if _, err := ctx.EvalFile("a.js", nil); err != nil {
fmt.Printf("%v\n", err)
return
}
if err := ctx.BindFunc("add", &add); err != nil {
fmt.Printf("%v\n", err)
return
}
res := add(1, 2)
fmt.Println("result is:", res)
}
3. Javascript calls Go function
Javascript calling Go function is also easy. In the Go code, make a Golang function
as Javascript global function by calling EvalFile by registering. There's the example:
package main
import "github.com/rosbit/go-quickjs"
// function to be called by Javascript
func adder(a1 float64, a2 float64) float64 {
return a1 + a2
}
func main() {
ctx, err := quickjs.NewContext()
if err != nil {
fmt.Printf("%v\n", err)
return
}
defer ctx.Free()
if _, err := ctx.EvalFile("b.js", map[string]interface{}{
"adder": adder,
}) // b.js containing code calling "adder"
}
In Javascript code, one can call the registered function directly. There's the example b.js.
r = adder(1, 100) // the function "adder" is implemented in Go
console.log(r)
Status
The package is not fully tested, so be careful.
Contribution
Pull requests are welcome! Also, if you want to discuss something send a pull request with proposal and changes. Convention: fork the repository and make changes on your fork in a feature branch.
Documentation
¶
Overview ¶
*
- generate a key for any value.
- Rosbit Xu <me@rosbit.cn>
- Oct. 28, 2018
Index ¶
- type JsContext
- func (ctx *JsContext) BindFunc(funcName string, funcVarPtr interface{}) (err error)
- func (ctx *JsContext) BindFuncs(funcName2FuncVarPtr map[string]interface{}) (err error)
- func (ctx *JsContext) Eval(script string, env map[string]interface{}) (res interface{}, err error)
- func (ctx *JsContext) EvalFile(scriptFile string, env map[string]interface{}) (res interface{}, err error)
- func (ctx *JsContext) Free()
- func (ctx *JsContext) GetGlobal(name string) (res interface{}, err error)
- type V2KPool
- type Val2KeyFunc
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type JsContext ¶
func NewContext ¶
func (*JsContext) BindFunc ¶
bind a var of golang func with a JS function name, so calling JS function is just calling the related golang func. @param funcVarPtr in format `var funcVar func(....) ...; funcVarPtr = &funcVar`
type V2KPool ¶ added in v0.1.2
type V2KPool struct {
// contains filtered or unexported fields
}
func NewV2KPool ¶ added in v0.1.2
func NewV2KPool(val2key Val2KeyFunc, valHashable bool) *V2KPool
type Val2KeyFunc ¶ added in v0.1.2
type Val2KeyFunc func(val interface{}) (interface{}, error) // different val mapped to different key
Source Files