luau-lang/luau
1
0
Fork 0
mirror of https://github.com/luau-lang/luau.git synced 2025-01-19 09:18:07 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update typecheck.md (#1)

Browse source
This commit is contained in:
Arseny Kapoulkine 2020-06-18 18:43:38 -07:00 committed by GitHub
parent 876b2ad644
commit 68264852a9
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
docs/typecheck.md
View file

@ -4,7 +4,7 @@ Luau supports a gradual type system through the use of type annotations and type
## Type inference modes ## Type inference modes
There are three modes currently available. Each one differ in important ways. They must be annotated on the top few lines among the comments. There are three modes currently available. They must be annotated on the top few lines among the comments.
* `--!nocheck`, * `--!nocheck`,
* `--!nonstrict` (default), and * `--!nonstrict` (default), and
@ -44,7 +44,7 @@ local b2: B = a1 -- not ok
## Primitive types ## Primitive types
In Lua, we have 8 primitive types: `nil`, `string`, `number`, `boolean`, `table`, `function`, `thread`, and `userdata`. Of these, only `table` and `function` are not represented by name, but have their dedicated syntax as covered in this [syntax document](syntax.md). Note that we have explicitly skipped `userdata` from the type system. Lua VM supports 8 primitive types: `nil`, `string`, `number`, `boolean`, `table`, `function`, `thread`, and `userdata`. Of these, `table` and `function` are not represented by name, but have their dedicated syntax as covered in this [syntax document](syntax.md), and `userdata` is represented by [concrete types](#Roblox types); other types can be specified by their name.
Additionally, we also have `any` which is a special built-in type. It effectively disables all type checking, and thus should be used as last resort. Additionally, we also have `any` which is a special built-in type. It effectively disables all type checking, and thus should be used as last resort.
@ -107,7 +107,7 @@ f("foo") -- not ok
## Tables ## Tables
From the perspective of the programmers, there are three states you should care about. They are: `unsealed table`, `sealed table`, and `generic table`. This is intended to represent the relationship of two different tables. From the type checker perspective, each table can be in one of three states. They are: `unsealed table`, `sealed table`, and `generic table`. This is intended to represent how the table's type is allowed to change.
### Unsealed tables ### Unsealed tables
@ -137,7 +137,7 @@ v2.z = 3 -- not ok
### Sealed tables ### Sealed tables
A sealed table is a table that is now locked down. This occurs when the table constructor literal had 1 or more expression. A sealed table is a table that is now locked down. This occurs when the table constructor literal had 1 or more expression, or when the table type is spelt out explicitly via a type annotation.
```lua ```lua
local t = {x = 1} -- {x: number} local t = {x = 1} -- {x: number}
@ -261,11 +261,15 @@ local y: string = x -- ok
local z: number = x -- not ok local z: number = x -- not ok
``` ```
## Using Luau on Roblox ## Roblox types
All of Roblox's types are readily available for Luau's type inference engine to use, too. We can automatically deduce what your `Instance.new` is actually supposed to return. Roblox supports a rich set of classes and data types, [documented here](https://developer.roblox.com/en-us/api-reference). All of them are readily available for the type checker to use by their name (e.g. `Part` or `RaycastResult`).
Additionally, we can automatically deduce what calls like `Instance.new` and `game:GetService` are supposed to return:
```lua ```lua
local part = Instance.new("Part") local part = Instance.new("Part")
local basePart: BasePart = part local basePart: BasePart = part
``` ```
Note that many of these types provide some properties and methods in both lowerCase and UpperCase; the lowerCase variants are deprecated, and the type system will ask you to use the UpperCase variants instead.