Socket
Socket
Sign inDemoInstall

tsx

Package Overview
Dependencies
3
Maintainers
1
Versions
98
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

tsx


Version published
Weekly downloads
3M
increased by0.17%
Maintainers
1
Install size
9.04 MB
Created
Weekly downloads
 

Package description

What is tsx?

The tsx npm package is a CLI tool for running TypeScript and TSX files directly without pre-compilation. It's essentially a TypeScript execution and REPL for node.js, similar to how `node` works for JavaScript. It allows developers to quickly run scripts and prototypes written in TypeScript, including support for TSX (TypeScript with JSX syntax), which is commonly used in React development.

What are tsx's main functionalities?

Execute TypeScript files directly

Allows you to run a TypeScript file directly from the command line without needing to compile it first. This is particularly useful for quick scripts or during development.

tsx script.ts

REPL mode

Launches a REPL (Read-Eval-Print Loop) where you can type and execute TypeScript code interactively. This is useful for testing small snippets of code quickly.

tsx

Support for TSX

Enables execution of TSX files, which is TypeScript with JSX syntax. This is particularly useful for React developers who want to test components or scripts that include JSX.

tsx component.tsx

Other packages similar to tsx

Readme

Source

tsx

Node.js runtime that can instantaneously load TypeScript & ESM, powered by esbuild.

Features

  • Transforms TypeScript & ESM → to CJS or ESM (depending on package type)
  • Supports TS extensions .cjs & .mjs (.cts & .mts)
  • Supports Node.js v12.20+
  • Handles node: import prefixes
  • Hides experimental feature warnings

Install

npm install --save-dev tsx

Install globally

Install it globally to use it anywhere, outside of your npm project, without npx.

npm install --global tsx

Usage

Note: Commands are prefixed with npx to execute the tsx binary, but it's not necessary if globally installed or when using it in the script object in package.json

Run TypeScript / ESM / CJS module

npx tsx ./file.ts

Watch mode

Run file and automatically re-run on changes.

All imported files are watched except from the following directories: node_modules, bower_components, vendor, dist, and .* (hidden directories).

Press Return to manually re-run.

npx tsx watch ./file.ts

Cache

Modules transformations are cached in the system cache directory (TMPDIR). Transforms are cached by content hash so duplicate dependencies are not re-transformed.

Set the --no-cache flag to disable the cache:

npx tsx --no-cache ./file.ts

Dependencies

Keywords

FAQs

Last updated on 11 May 2022

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Packages

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc