txiki.js — The tiny JavaScript runtime
Overview
txikia (basque): small, tiny.
txiki.js is a small and powerful JavaScript runtime. It's built on the shoulders of
giants: it uses QuickJS as its JavaScript engine, libuv as the platform layer,
wasm3 as the WebAssembly engine and curl as the HTTP / WebSocket client.
It targets ECMAScript 2020 and implements many web platform features.
See it in action here:
Getting started
First head over to building and build the runtime.
$ ./build/tjs eval "console.log('hello world')"
hello world
$
If you want to run a script you can use tjs run:
$ ./build/tjs run examples/hello_world.js
hello world
$
Explore all the options:
$ ./build/tjs --help
Features
Support for the ES2020 specification plus some ES2020+ features like top level await.
Web Platform APIs
- alert, confirm, prompt (1)
- Console
- Crypto (2)
- Encoding API
- EventTarget
- fetch
- JSON modules
- Performance
- setTimeout, setInterval
- Streams API
- URL
- URLPattern
- URLSearchParams
- WebAssembly (3)
- WebSocket
- Web Workers API
(1): All of them are async.
(2): No subtle support.
(3): No tables, globals or memory support.
Runtime features
- TCP and UDP sockets
- Unix sockets / named pipes
- Signal handling
- File operations
- Child processes
- DNS (getaddrinfo)
- WASI
- Miscellaneous utility functions
See the full API documentation.
Other extras:
- Import directly from HTTP(S) URLs
- Import JSON files
- BigFloat and BigDecimal extensions
- Builtin test runner
Standard library
The following modules compose the standard library:
tjs:asserttjs:ffitjs:getoptstjs:hashingtjs:ipaddrtjs:pathtjs:sqlitetjs:uuid
Supported platforms
- GNU/Linux
- macOS
- Windows (beta)
- Other Unixes (please test!)
Building
CMake is necessary.
NOTE: The txiki.js build depends on a number of git submodules (libffi, libuv and wasm3).
If you didn't already clone this repository recursively, make sure you initialize these
submodules with git submodule update --init before proceeding to the build.
GNU/Linux
Install dependencies (libcurl, build-essential, cmake):
# On Debian / Ubuntu
sudo apt install libcurl4-openssl-dev build-essential cmake
macOS
Install dependencies (cmake, autoconf):
brew install cmake autoconf
Unix systems
# Get the code
git clone --recursive https://github.com/saghul/txiki.js --shallow-submodules && cd txiki.js
# Compile it!
make
# Run the REPL
./build/tjs
Windows (beta)
Building has only been tested in 64bit Windows.
Prerequisites
First make sure you have MSYS2 installed. The mingw64 and clang64 environments are currently tested.
Then install the required dependencies:
pacman -S git make pactoys
pacboy -S curl-winssl:p toolchain:p cmake:p ninja:p
Build
These commands must be run in a MinGW64 or clang64 shell.
make
This will build the executable just like on Unix. Note that at this point there are a number of dynamically linked libraries, so if you want to use the executable on a different system you'll need to copy those too. Check the list with ldd build/tjs.exe.
Running the tests
Make sure these commands are run from Windows Terminal (mintty, what MSYS2 provides is not supported).
make test
Versioning
At this time txiki.js uses calendar versioning with the form YY.MM.MICRO.