Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/fajarnugraha37/ts-rex/llms.txt

Use this file to discover all available pages before exploring further.

TS-Rex is published to the npm registry as @fajarnugraha37/ts-rex. You can install it with any Node.js-compatible package manager. The package ships prebuilt ESM and CJS bundles alongside TypeScript declaration files, so no additional build configuration is required.

​
Install the package

Choose your package manager and run the corresponding command: 
npm install @fajarnugraha37/ts-rex

​
TypeScript requirement

TS-Rex uses advanced generic type inference features introduced in TypeScript 5.0. The phantom type state tracking and compile-time capture inference rely on these features and will not work correctly with earlier versions.
TypeScript 5.0 or higher is required. If your project uses an older version, upgrade TypeScript before installing TS-Rex.
You can check your current TypeScript version with: 
npx tsc --version
TS-Rex declares TypeScript as a peer dependency in package.json: 
{
  "peerDependencies": {
    "typescript": "^5"
  }
}

​
Module formats

The package ships three output formats from the dist/ directory, so it works in any modern JavaScript environment without extra configuration:
FileFormatUse case
dist/index.mjsESMNode.js with "type": "module", bundlers (Vite, esbuild, Rollup)
dist/index.cjsCJSNode.js CommonJS, older bundlers
dist/index.d.tsType declarationsTypeScript type checking in all environments
The package.json exports field maps these automatically based on your environment: 
{
  "exports": {
    ".": {
      "types": "./dist/index.d.ts",
      "import": "./dist/index.mjs",
      "require": "./dist/index.cjs"
    }
  }
}

​
Import the library

Once installed, import the rx factory function to start building patterns. This is the only named export you need for most use cases: 
import { rx } from '@fajarnugraha37/ts-rex';
If you need to reference the builder or result types explicitly in your own type signatures, you can import them alongside rx: 
import { rx, RegexBuilder, CompiledRegex, MatchResult } from '@fajarnugraha37/ts-rex';

​
Zero runtime dependencies

TS-Rex has no runtime dependencies. The devDependencies in package.json include build tools (tsup, tsx), testing utilities (expect-type), and linting (eslint, typescript-eslint) — none of which are bundled into the distributed package.
Because TS-Rex depends only on native TypeScript and RegExp, adding it to your project does not increase your production bundle size beyond the library itself.

​
Next steps

Quickstart

Build your first type-safe regex pattern in under five minutes.

Core concepts

Understand the AST engine, immutability, and phantom type state.

Build docs developers (and LLMs) love

Get started for freeTalk to us