-
Notifications
You must be signed in to change notification settings - Fork 86
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
25 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
sidebar_position: 2 | ||
--- | ||
|
||
# TypeScript | ||
|
||
Some modules can be used in [roblox-ts](https://roblox-ts.com/). These modules live within their own `@rbxutil` NPM org. | ||
|
||
For a full listing of the available NPM packages, visit the [RbxUtil NPM org](https://www.npmjs.com/settings/rbxutil/packages). | ||
|
||
## Installation | ||
|
||
Installing modules works like any other roblox-ts package, except that the suffix will be `@rbxutil`. For instance, to install the quaternion library, run the following command: | ||
|
||
```bash | ||
$ npm install @rbxutil/quaternion | ||
``` | ||
|
||
## Configuration | ||
|
||
In the `tsconfig.json` file, add the `@rbxutil` directory to the types list. The `@rbxts` org should already be there: | ||
|
||
```json | ||
"typeRoots": ["node_modules/@rbxts", "node_modules/@rbxutil"] | ||
``` |