https://github.com/TypeScriptToLua/lua-types

TypeScript definitions for Lua standard library.
https://github.com/TypeScriptToLua/lua-types

Last synced: 3 months ago
JSON representation

TypeScript definitions for Lua standard library.

• Host: GitHub
• URL: https://github.com/TypeScriptToLua/lua-types
• Owner: TypeScriptToLua
• License: mit
• Created: 2018-01-04T04:15:39.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2022-11-28T20:10:06.000Z (almost 2 years ago)
• Last Synced: 2024-07-13T03:04:14.753Z (4 months ago)
• Language: TypeScript
• Homepage:
• Size: 850 KB
• Stars: 77
• Watchers: 6
• Forks: 11
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Lua Types

[![npm](https://img.shields.io/npm/v/lua-types.svg)](https://npmjs.com/package/lua-types) [![Travis](https://img.shields.io/travis/ark120202/lua-types.svg)](https://travis-ci.org/ark120202/lua-types)

> TypeScript definitions for Lua standard library

## Installation

> NOTE: In most of cases your environment-specific types would already include this package. In that case you don't need to do anything. If you're a developer of such types you should add `lua-types` as a dependency and load it by adding `/// `

1. Get this package from npm

```bash

yarn add -D lua-types

# or

npm install -D lua-types

```

2. Modify your `tsconfig.json`

```diff

{

  "compilerOptions": {

+    "types": ["lua-types/"]

  }

}

```

Where `` is one of:

-   `5.1`

-   `5.2`

-   `5.3`

-   `5.4`

-   `jit`

> NOTE: All other files in this module shouldn't be considered public. Do not import them manually, as they may change in non-major updates. If your environment doesn't provide all of standard Lua features, consider banning them with a [no-restricted-globals](https://eslint.org/docs/rules/no-restricted-globals) eslint rule.