Let Node run TS files or add to your library to give it the ability to execute TypeScript.
- Tiny: 5 KB + 1 dependency (9 KB) minified.
- Does not bundle a compiler, instead uses the compiler installed in the project.
- Transform files based on closest
tsconfig.json
. - Support
baseDir
&paths
alias. - Support
.cts
and.mts
files, as well asmodule: "ESNext"
.
Warning
Directory indexes and omit file extensions are only work for require()
, and import
in TS files when target
is set to CommonJS
.
Fallback *.js
import to *.ts
file is supported.
Supported compilers:
Different with builder:
- TS-Directly use ESM Loader Hooks that is more efficient than builder. After transpiling the code, builder will merge chunks and write the result to files, which takes more time and is redundant for Node.
Why not:
- ts-node doesn't work when your package type is "module".
- tsx bundles
esbuild
, while TS-Directly supports several compilers - it's more friendly to projects that don't useesbuild
.
Since TS-Directly does not bundle a compiler, you need to install one of the @swc/core
, esbuild
, sucrase
, typescript
. In the vast majority of cases TS-Directly works out-of-box:
- Projects using TypeScript usually have
typescript
installed. - Compilers from other installed packages (e.g.
vite
has dependencyesbuild
) can also be used by TS-Directly.
If multiple compilers available, the fastest will be used (see Performance).
pnpm add ts-directly
You can register ts-directly with Node options:
node --import ts-directly/register main.ts
Or register in code:
import module from "module";
// Use nullable check for compatibility with runtimes other than Node.
module.register?.("ts-directly", import.meta.url);
// TS files can be imported after registration.
await import("./file/import/ts/modules.ts");
Use the API:
declare function transform(code: string, filename: string, format?: ScriptType): Promise<LoadFnOutput>;
Transform the module from TypeScript to JavaScript using a supported compiler, the compiler options is read from closest tsconfig.json.
code
: TypeScript code to compile.filename
: The filename, must have a valid JS or TS extension.format
: Specify the output formatcommonjs
ormodule
, if omitted it will be determined automatically.
Returns a promise of object with properties:
format
:module
if the output module is ESM,commonjs
for CJS.source
: The JS code.shortCircuit
: alwaystrue
, make the object satisfiesLoadFnOutput
import { readFileSync, writeFileSync } from "fs";
import { transform } from "ts-directly";
const file = "module.ts";
const tsCode = readFileSync(file, "utf8");
const { source, format } = await transform(tsCode, file);
You can specify the compiler by set TS_COMPILER
environment variable, possible values: swc
, esbuild
, sucrase
and tsc
.
TS_COMPILER=tsc && node --import ts-directly/register main.ts
Transform 1322 files, see benchmark/loader.ts.
OS: Windows11, AMD Ryzen 5 5625U, PCIe 3.0 NVMe SSD.
No. | compiler | time | time.SD | time.ratio | filesize | filesize.ratio |
---|---|---|---|---|---|---|
0 | swc | 344.24 ms | 1.25 ms | 0.00% | 8.45 MiB | 0.00% |
1 | esbuild | 422.70 ms | 6.73 ms | +22.79% | 8.33 MiB | -1.49% |
2 | sucrase | 481.72 ms | 7.07 ms | +39.94% | 8.93 MiB | +5.67% |
3 | tsc | 2,844.11 ms | 22.32 ms | +726.21% | 8.74 MiB | +3.37% |
Download the latest version of this project, and build it:
git clone https://github.com/Kaciras/ts-directly.git
cd ts-directly
pnpm install
pnpm run build
Then you can use the loader, or run tests:
pnpm run test
Run benchmark (files in benchmark/
):
pnpm exec esbench --file loader.ts