Typia

Pick your setup path

typia is a compile-time transformer, so it has to plug into your TypeScript build. There are two supported paths — pick the one that matches your TypeScript version.

Path	When to use	Package	Default?
TypeScript-Go (`ttsc`)	TypeScript-Go preview (`@typescript/native-preview`) — experimental	`typia@next`	experimental preview
Legacy (`ts-patch`)	Stable TypeScript v5 or v6 (the standard `typescript` npm package)	`typia`	✅ recommended

TypeScript-Go is the in-progress Go-rewrite of the TypeScript compiler shipped by the TypeScript team. The transformer plug-in API is settled, but packaging and binary naming are not — pin versions carefully and expect breakage.

Legacy is what every typia user is running in production today. It patches the JavaScript-based tsc at install time via ts-patch; from then on every tsc build applies the typia transform. No experimental preview required.

If you don’t know which to pick, choose Legacy.

TypeScript-Go

Use typia@next. TypeScript is migrating its compiler from JavaScript to Go (the “TypeScript-Go” project). ttsc is the Go-native plugin toolchain for that compiler, and typia@next ships a Go-rewritten transform that plugs into it.

npm

Terminal


# install
npm i typia@next
npm i -D ttsc @typescript/native-preview
 
# build
npx ttsc
 
# run without building first
npx ttsx src/index.ts

pnpm

Terminal


# install
pnpm i typia@next
pnpm i -D ttsc @typescript/native-preview
 
# build
pnpm ttsc
 
# run without building first
pnpm ttsx src/index.ts

yarn

Terminal


# install
yarn add typia@next
yarn add -D ttsc @typescript/native-preview
 
# build
yarn ttsc
 
# run without building first
yarn ttsx src/index.ts

bun

Terminal


# install
bun add typia@next
bun add -d ttsc @typescript/native-preview
 
# build
bun ttsc
 
# run without building first
bun ttsx src/index.ts

Important

You must use ttsc and ttsx. The stock tsc, ts-node, and tsx cannot apply the typia transform, so they will silently produce a build with no validators.

For bundlers, use @ttsc/unplugin:

Vite

vite.config.ts


import ttsc from "@ttsc/unplugin/vite";
import { defineConfig } from "vite";
 
export default defineConfig({
  plugins: [ttsc()],
});

Next.js

next.config.mjs


import withTtsc from "@ttsc/unplugin/next";
 
/** @type {import("next").NextConfig} */
const nextConfig = {
  reactStrictMode: true,
};
 
export default withTtsc(nextConfig);

Rollup

rollup.config.ts


import ttsc from "@ttsc/unplugin/rollup";
 
export default {
  input: "src/index.ts",
  output: {
    dir: "dist",
    format: "esm",
  },
  plugins: [ttsc()],
};

Rolldown

rolldown.config.ts


import ttsc from "@ttsc/unplugin/rolldown";
import { defineConfig } from "rolldown";
 
export default defineConfig({
  input: "src/index.ts",
  output: {
    dir: "dist",
    format: "esm",
  },
  plugins: [ttsc()],
});

esbuild

esbuild.config.ts


import ttsc from "@ttsc/unplugin/esbuild";
import { build } from "esbuild";
 
await build({
  entryPoints: ["src/index.ts"],
  outdir: "dist",
  bundle: true,
  plugins: [ttsc()],
});

Webpack

webpack.config.mjs


import ttsc from "@ttsc/unplugin/webpack";
 
export default {
  entry: "./src/index.ts",
  output: {
    path: new URL("./dist", import.meta.url).pathname,
  },
  plugins: [ttsc()],
};

Rspack

rspack.config.mjs


import ttsc from "@ttsc/unplugin/rspack";
 
export default {
  entry: "./src/index.ts",
  plugins: [ttsc()],
};

Farm

farm.config.ts


import ttsc from "@ttsc/unplugin/farm";
import { defineConfig } from "@farmfe/core";
 
export default defineConfig({
  plugins: [ttsc()],
});

Bun

build.ts


import ttsc from "@ttsc/unplugin/bun";
 
await Bun.build({
  entrypoints: ["src/index.ts"],
  outdir: "dist",
  plugins: [ttsc()],
});

Continue to TypeScript-Go setup for the full configuration reference.

Legacy

Use typia. The legacy path uses ts-patch on top of the JavaScript-based TypeScript compiler. This is the stable release path used in production today.

npm

Terminal


# install
npm i typia
npm i -D typescript ts-node ts-patch
npx typia setup
 
# build
npx tsc
 
# run without building first
npx ts-node src/index.ts

pnpm

Terminal


# install
pnpm i typia
pnpm i -D typescript ts-node ts-patch
pnpm typia setup --manager pnpm
 
# build
pnpm tsc
 
# run without building first
pnpm ts-node src/index.ts

yarn

Terminal


# install
# Yarn Berry is NOT supported
yarn add typia
yarn add -D typescript ts-node ts-patch
yarn typia setup --manager yarn
 
# build
yarn tsc
 
# run without building first
yarn ts-node src/index.ts

bun

Terminal


# install
bun add typia
bun add -d typescript ts-node ts-patch
bun typia setup
 
# build
bun tsc
 
# run without building first
bun ts-node src/index.ts

npx typia setup runs a one-shot wizard that installs the right ts-patch plugin entry into your tsconfig.json and wires up a prepare script.

For bundlers, use @typia/unplugin:

Vite

vite.config.ts


import UnpluginTypia from "@typia/unplugin/vite";
import { defineConfig } from "vite";
 
export default defineConfig({
  plugins: [UnpluginTypia()],
});

Next.js

next.config.mjs


import unTypiaNext from "@typia/unplugin/next";
 
/** @type {import("next").NextConfig} */
const config = {
  reactStrictMode: true,
};
 
export default unTypiaNext(config);

esbuild

esbuild.config.js


import { build } from "esbuild";
import UnpluginTypia from "@typia/unplugin/esbuild";
 
build({
  plugins: [UnpluginTypia()],
});

Bun.runtime

preload.ts


import { plugin } from "bun";
import UnpluginTypia from "@typia/unplugin/bun";
 
plugin(UnpluginTypia());

bunfig.toml


preload = ["./preload.ts"]
 
[test]
preload = ["./preload.ts"]

Bun.build

build.ts


import UnpluginTypia from "@typia/unplugin/bun";
 
await Bun.build({
  entrypoints: ["./index.ts"],
  outdir: "./out",
  plugins: [UnpluginTypia()],
});

Continue to Legacy setup for tsconfig.json details, NX, Webpack notes, and the generation fallback for projects that can’t run a transformer (Babel, SWC).

Verify the setup

Drop this into your project and run it:

src/check-setup.ts


import typia from "typia";
 
console.log(typia.is<{ id: string }>({ id: "ok" }));
// → true

If you see true, the transformer ran. If you see an error like typia transformer has not been configured, the build is using stock tsc / tsx instead of ttsc / ttsx or ts-patch. Re-check the build command and tsconfig.json plugin entry.

Where to go next

Full ttsc setup including bundler plugins → TypeScript-Go setup
Full ts-patch setup, NX, Webpack, generation-mode fallback → Legacy setup
First validator after setup → is · assert · validate
Why typia needs a transform at all → Pure TypeScript