Skip to main content

TypeScriptToLua

Write Lua with TypeScript

function onAbilityCast(caster: Unit, targetPos: Vector) {
const units = findUnitsInRadius(targetPos, 500);

const enemies = units.filter(unit => caster.isEnemy(unit));

for (const enemy of enemies) {
enemy.kill();
}

}
function onAbilityCast(caster, targetPos)
local units = findUnitsInRadius(targetPos, 500)
local enemies = __TS__ArrayFilter(
units,
function(____, unit) return caster:isEnemy(unit) end
)
for ____, enemy in ipairs(enemies) do
enemy:kill()
end
end

Declare and use existing APIs

This project is useful in any environment where Lua code is accepted, with the powerful option of declaring types for any existing API using TypeScript declaration files.

Type Safety

Static types can ease the mental burden of writing programs, by automatically tracking information the programmer would otherwise have to track mentally in some fashion. Types serve as documentation for yourself and other programmers and provide a check that tells you what terms make sense to write.

IDE Support

Types enable Lua developers to use highly-productive development tools and practices like static checking and code refactoring when developing Lua applications. TypeScript extensions are available for many text editors.

Getting started

Getting started with TSTL is easy, simply install typescript-to-lua from npm:

$ npm install -D typescript typescript-to-lua

You can now run tstl via command line, similar to tsc

$ npx tstl

For more information, see tstl Getting Started documentation.