UNPKG

@rbxts/types/README.md

Version:

449 BMarkdownView Raw

1# @rbxts/types
2
3TypeScript typings for the Roblox platform. Partially handwritten and partially automatically generated.
4
5## Installation
6
7To install @rbxts/types into your project, run the following command:
8
9`npm i -D @rbxts/types`
10
11Then, make sure `node_modules/@rbxts` is listed in your `compilerOptions.typeRoots` field in your project's `tsconfig.json` like so:
12
13```json
14{
15	"compilerOptions": {
16		"typeRoots": ["node_modules/@rbxts"]
17	}
18}
19```

1	`# @rbxts/types`
2
3	`TypeScript typings for the Roblox platform. Partially handwritten and partially automatically generated.`
4
5	`## Installation`
6
7	`To install @rbxts/types into your project, run the following command:`
8
9	`npm i -D @rbxts/types`
10
11	Then, make sure `node_modules/@rbxts` is listed in your `compilerOptions.typeRoots` field in your project's `tsconfig.json` like so:
12
13	```json
14	`{`
15	`"compilerOptions": {`
16	`"typeRoots": ["node_modules/@rbxts"]`
17	`}`
18	`}`
19	```