lua-in-js/README.md

lua-in-js

  Badges are clickable!

A Lua to JS transpiler/runtime. This library is a rewrite of Starlight with a lot of improvements.

Install

npm i lua-in-js

API

Import

const luainjs = require(luainjs)
// or
import luainjs from 'luainjs'

Create the lua environment

Lua environments are isolated from each other (they got different global scopes)

const luaEnv = luainjs.createEnv()

A config object can be passed in for extra functionality

const luaEnv = luainjs.createEnv({
    LUA_PATH, // default value of package.path
    fileExists, // function that takes in a path and returns a boolean
    loadFile, // function that takes in a path and returns the content of a file
    stdin, // string representing the standard input
    stdout, // function representing the standard output
    osExit // function called by os.exit
})

Run a script or file

luaEnv.run('print(\'Hello world!\')')

luaEnv.runfile('somefile.lua')

runfile uses config.fileExists and config.loadFile

Example

Check out the test runner for a concrete example.

Missing functionality

• coroutine library
• debug library
• utf8 library
• io library
• package.cpath
• package.loadlib
• string.dump
• string.pack
• string.packsize
• string.unpack
• os.clock
• os.execute
• os.getenv
• os.remove
• os.rename
• os.tmpname