Skip to content

Latest commit

 

History

History
96 lines (77 loc) · 7.4 KB

README.md

File metadata and controls

96 lines (77 loc) · 7.4 KB
Raw

rquickjs

github crates docs status

This library is a high level bindings the QuickJS JavaScript engine. Its goal is to be an easy to use, and safe wrapper similar to the rlua library.

QuickJS is a small and embeddable JavaScript engine. It supports the ES2020 specification including modules, asynchronous generators, proxies and BigInt. It optionally supports mathematical extensions such as big decimal floating point numbers (BigDecimal), big binary floating point numbers (BigFloat) and operator overloading.

Main features of QuickJS

  • Small and easily embeddable: just a few C files, no external dependency, 210 KiB of x86 code for a simple hello world program.
  • Fast interpreter with very low startup time: runs the 75000 tests of the ECMAScript Test Suite in about 100 seconds on a single core of a desktop PC. The complete life cycle of a runtime instance completes in less than 300 microseconds.
  • Almost complete ES2020 support including modules, asynchronous generators and full Annex B support (legacy web compatibility).
  • Passes nearly 100% of the ECMAScript Test Suite tests when selecting the ES2020 features. A summary is available at Test262 Report.
  • Can compile JavaScript sources to executables with no external dependency.
  • Garbage collection using reference counting (to reduce memory usage and have deterministic behavior) with cycle removal.
  • Mathematical extensions: BigDecimal, BigFloat, operator overloading, bigint mode, math mode.
  • Command line interpreter with contextual colorization implemented in JavaScript.
  • Small built-in standard library with C library wrappers.

Features provided by this crate

  • Full integration with async Rust
    • The ES6 Promises can be handled as Rust futures and vice versa
    • Easy integration with almost any async runtime or executor
  • Flexible data conversion between Rust and JS
    • Many widely used Rust types can be converted to JS and vice versa
  • Support for user-defined allocators
    • The Runtime can be created using custom allocator
    • Using Rust's global allocator is also fully supported
  • Support for user-defined module resolvers and loaders which also can be combined to get more flexible solution for concrete case
  • Support for bundling JS modules as a bytecode using embed macro
  • Support for deferred calling of JS functions
  • Full support of ES6 classes
    • Rust data types can be represented as JS classes
    • Data fields can be accessed via object properties
    • Both static and instance members is also supported
    • The properties can be defined with getters and setters
    • Support for constant static properties
    • Support for holding references to JS objects (Data type which holds refs should implement Trace trait to get garbage collector works properly)
    • Support for extending defined classes by JS

Community development

This crate doesn't aim to provide system and web APIs. The QuickJS library is close to V8 in that regard. If you need APIs from WinterGC or Node, then you can take a look at the follow community projects:

  • AWS LLRT Modules: Collection of modules that micmic some of the Node APIs in pure Rust

Development status

This bindings is feature complete, mostly stable and ready to use. The error handling is only thing which may change in the future. Some experimental features like parallel may not works as expected. Use it for your own risk.

Using rquickjs on windows

Note that the QuickJS library does not support windows natively, this library supports windows by patching QuickJS. For patching we use the patch utility which needs to be installed when building for windows. For more information see #88.

Supported platforms

Rquickjs needs to compile a C-library which has it's own limitation on supported platforms, furthermore it needs to generate bindings for that platform. As a result rquickjs might not compile on all platforms which rust supports. In general you can allways try to compile rquickjs with the bindgen feature, this should work for most platforms. Rquickjs ships bindings for a limited set of platforms, for these platforms you don't have to enable the bindgen feature. See below for a list of supported platforms.

platform shipped bindings tested supported by quickjs
x86_64-unknown-linux-gnu ✅ ✅ ✅
i686-unknown-linux-gnu ✅ ✅ ✅
aarch64-unknown-linux-gnu ✅ ✅ ✅
x86_64-unknown-linux-musl ✅ ✅ ✅
aarch64-unknown-linux-musl ✅ ✅ ✅
x86_64-pc-windows-gnu ✅ ✅ ✅
i686-pc-windows-gnu ✅ ✅ ✅
x86_64-pc-windows-mvsc ✅ ✅ ❌ experimental!
x86_64-apple-darwin ✅ ✅ ✅
aarch64-apple-darwin ✅ ❌ ✅
wasm32-wasi ✅ ❌ ✅
other ❌ ❌ Unknown

License

This library is licensed under the MIT License