https://github.com/tomblind/ts-liblua

Lua library declarations for TypeScript
https://github.com/tomblind/ts-liblua

Last synced: about 1 month ago
JSON representation

Lua library declarations for TypeScript

• Host: GitHub
• URL: https://github.com/tomblind/ts-liblua
• Owner: tomblind
• License: mit
• Created: 2018-09-29T13:40:23.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2020-08-28T20:14:06.000Z (about 4 years ago)
• Last Synced: 2024-04-28T02:18:08.132Z (7 months ago)
• Size: 84 KB
• Stars: 3
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# TypeScript Lua Library Declarations

Lua library declarations for use with [TypeScriptToLua](https://github.com/TypeScriptToLua/TypeScriptToLua).

## Usage

Each declaration file is a complete set of declarations for a specific Lua version. Add the one that matches your lua version to your TypeScript project.

Note that there are two versions for [LuaJIT](https://luajit.org/): `lib.luajit.d.ts` and `lib.luajit52.ts`. The later should be used if you're using a version of LuaJIT compiled with [`LUAJIT_ENABLE_LUA52COMPAT`](https://luajit.org/extensions.html).

## Helper types

TypescriptToLua supports type annotations which allow additional features of Lua to be accessible from Typescript. Add `lib.tstl.d.ts` to your project to access convenience types already set up with these annotations. See [TypescriptToLua Compiler Annotations](https://typescripttolua.github.io/docs/advanced/compiler-annotations) for more details.

## Disabling Javascript Libraries

If you wish to disable the standard ES libraries and only use Lua's, add `lib.esnone.d.ts` to your project and set `noLib` in your TypeScript configuration.