Skip to content

Commit

Permalink
TS
Browse files Browse the repository at this point in the history
  • Loading branch information
Sleitnick committed Oct 17, 2023
1 parent f0f2996 commit 355911b
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions docs/ts.md
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"]
```

0 comments on commit 355911b

Please sign in to comment.