flutter_qjs

Pub Test

This plugin is a simple js engine for flutter using the quickjs project with dart:ffi. Plugin currently supports all the platforms except web!

Getting Started

Basic usage

Firstly, create a FlutterQjs object, then call dispatch to dispatch event loop:

final engine = FlutterQjs(
  stackSize: 1024 * 1024, // change stack size here.
);
engine.dispatch();

Use evaluate method to run js script, now you can use it synchronously, or use await to resolve Promise:

try {
  print(engine.evaluate(code ?? ''));
} catch (e) {
  print(e.toString());
}

Method close can destroy quickjs runtime that can be recreated again if you call evaluate. Parameter port should be close to stop dispatch loop when you do not need it.

engine.port.close(); // stop dispatch loop
engine.close();      // close engine
engine = null;

Data conversion between dart and js are implemented as follow:

dartjs
Boolboolean
Intnumber
Doublenumber
Stringstring
Uint8ListArrayBuffer
ListArray
MapObject
Function
JSInvokable
function(....args)
FuturePromise
JSErrorError
ObjectDartObject

notice: JSInvokable does not extend Function, but can be used same as Function. Dart function uses named argument thisVal to manage js function this:

func(arg1, arg2, {thisVal});

or use invoke method to pass list parameters:

(func as JSInvokable).invoke([arg1, arg2], thisVal);

Use modules

ES6 module with import function is supported and can be managed in dart with moduleHandler:

final engine = FlutterQjs(
  moduleHandler: (String module) {
    if(module == "hello")
      return "export default (name) => `hello \${name}!`;";
    throw Exception("Module Not found");
  },
);

then in JavaScript, import function is used to get modules:

import("hello").then(({default: greet}) => greet("world"));

notice: Module handler should be called only once for each module name. To reset the module cache, call FlutterQjs.close then evaluate again.

To use async function in module handler, try Run on isolate thread

Run on isolate thread

Create a IsolateQjs object, pass handlers to resolving modules. Async function such as rootBundle.loadString can be used now to get modules:

final engine = IsolateQjs(
  moduleHandler: (String module) async {
    return await rootBundle.loadString(
        "js/" + module.replaceFirst(new RegExp(r".js$"), "") + ".js");
  },
);
// not need engine.dispatch();

Same as run on main thread, use evaluate to run js script. In this way, Promise return by evaluate will be automatically tracked and return the resolved data:

try {
  print(await engine.evaluate(code ?? ''));
} catch (e) {
  print(e.toString());
}

Method close can destroy quickjs runtime that can be recreated again if you call evaluate.

notice: Make sure arguments passed to IsolateJSFunction are avaliable for isolate, such as primities and top level function. Method bind can help to pass instance function to isolate:

await jsFunc(await engine.bind(({thisVal}) {
  // DO SOMETHING
}));

This example contains a complete demonstration on how to use this plugin.

Breaking change in v0.3.0

channel function is no longer included by default. Use js function to set dart object globally:

final setToGlobalObject = await engine.evaluate("(key, val) => this[key] = val;");
await setToGlobalObject("channel", methodHandler);

Libraries

ffi
flutter_qjs
isolate
wrapper