Comparing version 2.6.1 to 2.6.2
{ | ||
"name": "lua-types", | ||
"version": "2.6.1", | ||
"version": "2.6.2", | ||
"description": "TypeScript definitions for Lua standard library", | ||
@@ -5,0 +5,0 @@ "keywords": [ |
@@ -12,5 +12,5 @@ # Lua Types | ||
> 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 `/// <reference types="lua-types/VERSION" />` | ||
> as a dependency and load it by adding `/// <reference types="lua-types/version" />` | ||
1. Get Lua Types from npm | ||
1. Get this package from npm | ||
@@ -28,3 +28,3 @@ ```bash | ||
"compilerOptions": { | ||
"types": ["lua-types/VERSION"] | ||
"types": ["lua-types/version"] | ||
} | ||
@@ -34,3 +34,3 @@ } | ||
Currently supported values of `VERSION` are: | ||
Currently supported versions are: | ||
@@ -43,22 +43,5 @@ - `5.1` | ||
## Loading only a subset of features | ||
Some Lua environments are sandboxed and don't have some globals declared, like `io`, `os` and | ||
`debug`. To avoid registering these globals, you can import core files separately. For example: | ||
```json | ||
{ | ||
"compilerOptions": { | ||
"types": [ | ||
"lua-types/core/coroutine", | ||
"lua-types/core/global", | ||
"lua-types/core/math", | ||
"lua-types/core/metatable", | ||
"lua-types/core/modules", | ||
"lua-types/core/string", | ||
"lua-types/core/table", | ||
"lua-types/special/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. |
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
122200
44