luaut-parser 2.0.0 → 2.1.0

package/README.md

@@ -117,6 +117,39 @@ name: T | nil   -- must be written, but may be nil
 Omitting an argument requires `?` (or a default), as in TypeScript — a
 parameter typed `T | nil` still has to be passed something.
 
+**Classes** — types are structural, except for classes. A definitions file
+declares one with `declare class`, and it is nominal, as Roblox's classes are:
+
+```luau
+declare class BasePart extends PVInstance { Size: Vector3 }
+declare class Part extends BasePart { Shape: EnumItem }
+```
+
+A `Part` is a `BasePart` and an `Instance` because it extends them. A
+`ReplicatedStorage` is not a `Part`, and no table literal is an `Instance`,
+however alike their members. A class still fits a shape that names members it
+has (`{ Name: string }`). It is not a table, though, so `typeof(part)` picks
+the `"Instance"` overload, not `"table"`. Members are inherited, and a subclass
+may narrow one (`Parent: SomeFolder`).
+
+**Callbacks** — a function written where a function type is expected takes
+its parameter types from it: in `signal:Connect(function(player) ... end)`,
+`player` is typed from `Connect`. The same applies to an annotated `const`
+and to an assignment such as `remote.OnServerInvoke = function(player) ...`.
+
+**Type packs** — `type Signal<T... = ...any> = { Connect: (self, cb: (T...) -> ()) -> () }`.
+A pack parameter takes every type argument from its position on:
+`Signal<Player, string>`, `Signal<()>` for none.
+
+**Operators** — on a type that declares metamethods (`__add`, `__mul`,
+`__unm`, ...), an operator has the metamethod's result, tried on the left
+operand and then the right one, as Luau does. So `Vector3 + Vector3` and
+`2 * vector` are both `Vector3`.
+
+**Qualified type names** — a definitions file may declare `Enum.Material`
+(`declare class Enum.Material extends EnumItem {}`), and code writes it the
+same way.
+
 **Calls** — every argument is checked against its parameter, and a generic
 parameter against its constraint (`GetService<K extends keyof Services>`
 rejects `""`).