roblox-ts

Use when writing TypeScript code for Roblox using roblox-ts, especially when unsure if a JavaScript API exists or how to handle Luau interop

Based on roblox-ts v3.0.0, generated 2026-01-31

TypeScript-to-Luau transpiler for Roblox. This is "Roblox with TypeScript syntax", not full JavaScript - many JS APIs don't exist.

Core References

| Topic | Description | Reference | | -------------- | ------------------------------------------------------- | -------------------------------------------------------- | | JS Differences | Missing APIs, assert() truthiness, any type, typeof | core-js-differences | | Type Checking | typeIs, classIs, RemoteEvent validation | core-type-checking | | Constructors | new syntax, DataType math (.add/.sub), collections | core-constructors | | Utility Types | satisfies, InstancePropertyNames, Services, ExtractKeys | core-utility-types |

Features

| Topic | Description | Reference | | -------------- | --------------------------------------------------------- | -------------------------------------------------------------- | | Luau Interop | $tuple, LuaTuple, type declarations, callbacks vs methods | feature-luau-interop | | Game Hierarchy | Typing Workspace children with services.d.ts | feature-game-hierarchy |