From 355911be6d8853406f50316cf6fb9e2a1a37fddf Mon Sep 17 00:00:00 2001 From: Stephen Leitnick Date: Tue, 17 Oct 2023 14:29:47 -0400 Subject: [PATCH] TS --- docs/ts.md | 25 +++++++++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 docs/ts.md diff --git a/docs/ts.md b/docs/ts.md new file mode 100644 index 00000000..9c0f5be9 --- /dev/null +++ b/docs/ts.md @@ -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"] +```