# esbuild-register

> Transpile JSX, TypeScript and esnext features on the fly with esbuild

Latest version **3.6.0** (published 2024-07-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install esbuild-register
pnpm add esbuild-register
yarn add esbuild-register
bun add esbuild-register
```

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 3.6.0 |
| Published | 2024-07-25 |
| First published | 2020-07-16 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 1 |
| Unpacked size | 177.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | egoist |

## Links

- npm: https://www.npmjs.com/package/esbuild-register
- npm.io page: https://npm.io/package/esbuild-register

## Dependencies (1)

- [debug](https://npm.io/package/debug.md) ^4.3.4

## Recent versions

- 3.6.0 (latest) — 2024-07-25
- 3.5.0 — 2023-09-14
- 3.4.2 — 2022-12-16
- 3.4.1 — 2022-11-10
- 3.4.0 — 2022-11-09
- 3.3.3 — 2022-06-04
- 3.3.2 — 2022-01-12
- 3.3.1 — 2021-12-28
- 3.3.0 — 2021-12-26
- 3.2.1 — 2021-12-12
- 3.2.0 — 2021-11-24
- 3.1.2 — 2021-11-09
- 3.1.1 — 2021-11-09
- 3.1.0 — 2021-11-08
- 3.0.0 — 2021-08-13
- … 16 more at https://npm.io/package/esbuild-register/versions

## README

# esbuild-register

[![npm version](https://badgen.net/npm/v/esbuild-register)](https://npm.im/esbuild-register) [![npm downloads](https://badgen.net/npm/dm/esbuild-register)](https://npm.im/esbuild-register)

## Install

```bash
npm i esbuild esbuild-register -D
# Or Yarn
yarn add esbuild esbuild-register --dev
# Or pnpm
pnpm add esbuild esbuild-register -D
```

## Usage

```bash
node -r esbuild-register file.ts
```

It will use `jsxFactory`, `jsxFragmentFactory` and `target` options from your `tsconfig.json`

### Experimental loader support

When using in a project with `type: "module"` in `package.json`, you need the `--loader` flag to load TypeScript files:

```bash
node --loader esbuild-register/loader -r esbuild-register ./file.ts
```

## Programmatic Usage

```ts
const { register } = require('esbuild-register/dist/node')

const { unregister } = register({
  // ...options
})

// Unregister the require hook if you don't need it anymore
unregister()
```

## Sponsors

[![sponsors](https://sponsors-images.egoist.dev/sponsors.svg)](https://github.com/sponsors/egoist)

## License

MIT © [EGOIST](https://egoist.dev)

---
_Source: https://npm.io/package/esbuild-register · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._