downloads
Across all versions.
Download trend unavailable.
compatibility
Runtime metadata.
Across all versions.
Download trend unavailable.
Runtime metadata.
Estimated unpacked size across 1 packages.
1.7 MB
Includes dependencies.
Docusaurus, ESLint, FormKit, Histoire, Knip, Nitro, Nuxt, PostCSS loader, Rsbuild, Size Limit, Slidev, Tailwindcss, Tokenami, UnoCSS, WXT, Winglang, Graphql code generator, Lingui, Scaffdog, Storybook, ...UnJS ecosystem, ...60M+ npm monthly downloads, ...6M+ public repositories.
import()require() (deprecated)require.cache integration[!IMPORTANT] To enhance compatibility, jiti
>=2.1enabledinteropDefaultusing a new Proxy method. If you migrated to2.0.0earlier, this might have caused behavior changes. In case of any issues during the upgrade, please report so we can investigate to solve them. 🙏🏼
You can use jiti CLI to quickly run any script with TypeScript and native ESM support!
npx jiti ./index.tsInitialize a jiti instance:
// ESM
import { createJiti } from "jiti";
const jiti = createJiti(import.meta.url);
// CommonJS (deprecated)
const { createJiti } = require("jiti");
const jiti = createJiti(__filename);Import (async) and resolve with ESM compatibility:
// jiti.import(id) is similar to import(id)
const mod = await jiti.import("./path/to/file.ts");
// jiti.esmResolve(id) is similar to import.meta.resolve(id)
const resolvedPath = jiti.esmResolve("./src");If you need the default export of module, you can use jiti.import(id, { default: true }) as shortcut to mod?.default ?? mod.
// shortcut to mod?.default ?? mod
const modDefault = await jiti.import("./path/to/file.ts", { default: true });CommonJS (sync & deprecated):
// jiti() is similar to require(id)
const mod = jiti("./path/to/file.ts");
// jiti.resolve() is similar to require.resolve(id)
const resolvedPath = jiti.resolve("./src");You can also pass options as the second argument:
const jiti = createJiti(import.meta.url, { debug: true });You can globally register jiti using global hooks. (Important: Requires Node.js > 20)
import "jiti/register";Or:
node --import jiti/register index.tsjiti/nativeYou can alias jiti to jiti/native to directly depend on runtime's import.meta.resolve and dynamic import() support. This allows easing up the ecosystem transition to runtime native support by giving the same API of jiti.
debugfalseJITI_DEBUGEnable verbose logging. You can use JITI_DEBUG=1 <your command> to enable it.
fsCachetrueJITI_FS_CACHEFilesystem source cache (enabled by default)
By default (when is true), jiti uses node_modules/.cache/jiti (if exists) or {TMP_DIR}/jiti.
Note: It is recommended that this option be enabled for better performance.
rebuildFsCachefalseJITI_REBUILD_FS_CACHERebuild filesystem source cache created by fsCache.
moduleCachetrueJITI_MODULE_CACHERuntime module cache (enabled by default).
Disabling allows editing code and importing the same module multiple times.
When enabled, jiti integrates with Node.js native CommonJS cache-store.
transformTransform function. See src/babel for more details
sourceMapsfalseJITI_SOURCE_MAPSAdd inline source map to transformed source for better debugging.
interopDefaulttrueJITI_INTEROP_DEFAULTJiti combines module exports with the default export using an internal Proxy to improve compatibility with mixed CJS/ESM usage. You can check the current implementation here.
[!WARNING] This option wraps all imported modules in a Proxy, which adds ~25-50ns overhead per property access. For performance-critical hot paths where you access module exports very frequently, consider setting
interopDefault: falseorJITI_INTEROP_DEFAULT=false.
aliasJITI_ALIASYou can also pass an object to the environment variable for inline config. Example: JITI_ALIAS='{"~/*": "./src/*"}' jiti ....
Custom alias map used to resolve IDs.
tsconfigPathsfalseJITI_TSCONFIG_PATHSEnable TypeScript paths resolution using get-tsconfig.
true: Auto-discover tsconfig.json by walking up from the jiti instance's parent path.string: Explicit path to a tsconfig.json file.false (default): Disabled.nativeModulesJITI_NATIVE_MODULESList of modules (within node_modules) to always use native require() for them.
transformModulesJITI_TRANSFORM_MODULESList of modules (within node_modules) to transform them regardless of syntax.
importMetaParent module's import.meta context to use for ESM resolution. (only used for jiti/native import).
tryNativeJITI_TRY_NATIVETry to use native require and import without jiti transformations first.
jsxfalseJITI_JSXEnable JSX support using @babel/plugin-transform-react-jsx.
See test/fixtures/jsx for framework integration examples.
corepack enablepnpm installpnpm devpnpm jiti ./test/path/to/file.ts