# quickjs-wrapper **Repository Path**: pythonzz/quickjs-wrapper ## Basic Information - **Project Name**: quickjs-wrapper - **Description**: HarlonWang QuickJS wrapper for Android/JVM - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: feat/build_cmake_test - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 0 - **Created**: 2024-08-30 - **Last Updated**: 2024-08-30 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README # QuickJS For Android/JVM QuickJS wrapper for Android/JVM. ## Feature - Java types are supported with JavaScript - Support promise execute - JavaScript exception handler - Optimize not a function with its name when type error - Compile bytecode Experimental Features Stability not guaranteed. - ESModule (import, export) ## Download [![Maven Central](https://img.shields.io/maven-central/v/wang.harlon.quickjs/wrapper-android.svg?label=Maven%20Central&color=blue)](https://search.maven.org/search?q=g:%22wang.harlon.quickjs%22%20AND%20a:%22wrapper-android%22) ```Groovy repositories { mavenCentral() } dependencies { // Pick one: // 1. Android - Use wrapper in your public API: api 'wang.harlon.quickjs:wrapper-android:latest.version' // 2. JVM - Use wrapper in your implementation only: implementation 'wang.harlon.quickjs:wrapper-java:latest.version' } ``` ### SNAPSHOT [![Wrapper](https://img.shields.io/static/v1?label=snapshot&message=wrapper&logo=apache%20maven&color=yellowgreen)](https://s01.oss.sonatype.org/content/repositories/snapshots/wang/harlon/quickjs/wrapper-android/)
See how to import the snapshot #### Including the SNAPSHOT Snapshots of the current development version of Wrapper are available, which track [the latest versions](https://s01.oss.sonatype.org/content/repositories/snapshots/wang/harlon/quickjs/wrapper-android/). To import snapshot versions on your project, add the code snippet below on your gradle file: ```Gradle repositories { maven { url 'https://s01.oss.sonatype.org/content/repositories/snapshots/' } } ``` Next, add the dependency below to your **module**'s `build.gradle` file: ```gradle dependencies { // For Android implementation "wang.harlon.quickjs:wrapper-android:latest-SNAPSHOT" // For JVM implementation "wang.harlon.quickjs:wrapper-java:latest-SNAPSHOT" } ```
## Usage ### Initialization In Android Platforms: ```Java // It is usually init in the application. QuickJSLoader.init(); ``` [Refer to here for other platforms.](./wrapper-java/README.md) ### Create QuickJSContext ```Java QuickJSContext context = QuickJSContext.create(); ``` ### Destroy QuickJSContext ```Java QuickJSContext context = QuickJSContext.create(); context.destroy(); ``` ### Evaluating JavaScript ```Java QuickJSContext context = QuickJSContext.create(); context.evaluate("var a = 1 + 2;"); ``` ### Console Support ```Java QuickJSContext context = QuickJSContext.create(); QuickJSLoader.initConsoleLog(context); // or custom console. // QuickJSLoader.initConsoleLog(context, your console implementation.); ``` ### Supported Types #### Java and JavaScript can directly convert to each other for the following basic types - `boolean` - `int` - `long` - `double` - `String` - `null` #### Mutual conversion of JS object types - `JSObject` represents a JavaScript object - `JSFunction` represents a JavaScript function - `JSArray` represents a JavaScript Array #### About Long type There is no Long type in JavaScript, the conversion of Long type is special. - Java --> JavaScript - The Long value <= Number.MAX_SAFE_INTEGER, will be convert to Number type. - The Long value > Number.MAX_SAFE_INTEGER, will be convert to BigInt type. - Number.MIN_SAFE_INTEGER is the same to above. - JavaScript --> Java: Number(Int64) or BigInt --> Long type ### Set Property Java ```java JSObject globalObj = context.getGlobalObject(); JSObject repository = globalObj.createNewJSObject(); obj1.setProperty("name", "QuickJS Wrapper"); obj1.setProperty("created", 2022); obj1.setProperty("version", 1.1); obj1.setProperty("signing_enabled", true); obj1.setProperty("getUrl", (JSCallFunction) args -> { return "https://github.com/HarlonWang/quickjs-wrapper"; }); globalObj.setProperty("repository", repository); ``` JavaScript ```javascript repository.name; // QuickJS Wrapper repository.created; // 2022 repository.version; // 1.1 repository.signing_enabled; // true repository.getUrl(); // https://github.com/HarlonWang/quickjs-wrapper ``` ### Get Property JavaScript ```JavaScript var repository = { name: 'QuickJS Wrapper', created: 2022, version: 1.1, signing_enabled: true, getUrl: (name) => { return 'https://github.com/HarlonWang/quickjs-wrapper'; } } ``` Java ```Java JSObject globalObject = context.getGlobalObject(); JSObject obj1 = globalObject.getJSObjectProperty("repository"); obj1.getString("name"); // QuickJS Wrapper obj1.getInteger("created"); // 2022 obj1.getDouble("version"); // 1.1 obj1.getBoolean("signing_enabled"); // true obj1.getJSFunction("getUrl").call(); // https://github.com/HarlonWang/quickjs-wrapper ``` ### Compile ByteCode ```Java byte[] code = context.compile("'hello, world!'.toUpperCase();"); context.execute(code); ``` ### ESModule Java ```Java JSModule.setModuleLoader(new JSModule.Loader() { @Override public String getModuleScript(String moduleName) { return "export var name = 'Hello world';\n" + "export var age = 18;"; } }); ``` JavaScript ```JavaScript import {name, age} from './a.js'; console.log('name：' + name); // Jack console.log('age：' + age); // 18 ``` ## R8 / ProGuard If you are using R8 the shrinking and obfuscation rules are included automatically. ProGuard users must manually add the options from [consumer-rules.pro](/wrapper-android/consumer-rules.pro). ## Concurrency JavaScript runtimes are single threaded. All execution in the JavaScript runtime is guaranteed thread safe, by way of Java synchronization. ## Who's using quickjs-wrapper? If your product uses quickjs-wrapper, welcome to contribute by creating a issue or let me know through other contacts! ## Find this repository useful? Support it by joining __[stargazers](https://github.com/HarlonWang/quickjs-wrapper/stargazers)__ for this repository.
Also, __[follow me](https://github.com/HarlonWang)__ on GitHub for my next creations! ## Stargazers over time [![Stargazers over time](https://starchart.cc/HarlonWang/quickjs-wrapper.svg)](https://starchart.cc/HarlonWang/quickjs-wrapper) ## Reference - [quickjs-java](https://github.com/cashapp/quickjs-java) - [quack](https://github.com/koush/quack) - [quickjs-android](https://github.com/taoweiji/quickjs-android)