README.md

@rbxts/types

TypeScript typings for the Roblox platform. Partially handwritten and partially automatically generated.

Installation

To install @rbxts/types into your project, run the following command:

npm i -D @rbxts/types

Then, make sure node_modules/@rbxts is listed in your compilerOptions.typeRoots field in your project's tsconfig.json like so:

{
	"compilerOptions": {
		"typeRoots": ["node_modules/@rbxts"]
	}
}