Interface TsNodeDefinition

Type Declaration

• Optionalcompiler?: string

  Specify a custom TypeScript compiler.

• OptionalcompilerHost?: boolean

  Use TypeScript's compiler host API instead of the language service API.

• OptionalcompilerOptions?: {
      allowArbitraryExtensions?: boolean;
      allowImportingTsExtensions?: boolean;
      allowJs?: boolean;
      allowSyntheticDefaultImports?: boolean;
      allowUmdGlobalAccess?: boolean;
      allowUnreachableCode?: boolean;
      allowUnusedLabels?: boolean;
      alwaysStrict?: boolean;
      assumeChangesOnlyAffectDirectDependencies?: boolean;
      baseUrl?: string;
      charset?: string;
      checkJs?: boolean;
      composite?: boolean;
      customConditions?: string[];
      declaration?: boolean;
      declarationDir?: string;
      declarationMap?: boolean;
      diagnostics?: boolean;
      disableReferencedProjectLoad?: boolean;
      disableSizeLimit?: boolean;
      disableSolutionSearching?: boolean;
      disableSourceOfProjectReferenceRedirect?: boolean;
      downlevelIteration?: boolean;
      emitBOM?: boolean;
      emitDeclarationOnly?: boolean;
      emitDecoratorMetadata?: boolean;
      erasableSyntaxOnly?: boolean;
      esModuleInterop?: boolean;
      exactOptionalPropertyTypes?: boolean;
      experimentalDecorators?: boolean;
      extendedDiagnostics?: boolean;
      fallbackPolling?:
          | "fixedPollingInterval"
          | "priorityPollingInterval"
          | "dynamicPriorityPolling"
          | "fixedInterval"
          | "priorityInterval"
          | "dynamicPriority"
          | "fixedChunkSize";
      forceConsistentCasingInFileNames?: boolean;
      generateCpuProfile?: string;
      importHelpers?: boolean;
      importsNotUsedAsValues?: "preserve"
      | "remove"
      | "error";
      incremental?: boolean;
      inlineSourceMap?: boolean;
      inlineSources?: boolean;
      isolatedDeclarations?: boolean;
      isolatedModules?: boolean;
      jsx?: "preserve" | "react" | "react-jsx" | "react-jsxdev" | "react-native";
      jsxFactory?: string;
      jsxFragmentFactory?: string;
      jsxImportSource?: string;
      keyofStringsOnly?: boolean;
      lib?: (
          | "ES5"
          | "ES6"
          | "ES2015"
          | "ES2015.Collection"
          | "ES2015.Core"
          | "ES2015.Generator"
          | "ES2015.Iterable"
          | "ES2015.Promise"
          | "ES2015.Proxy"
          | "ES2015.Reflect"
          | "ES2015.Symbol.WellKnown"
          | "ES2015.Symbol"
          | "ES2016"
          | "ES2016.Array.Include"
          | "ES2017"
          | "ES2017.Intl"
          | "ES2017.Object"
          | "ES2017.SharedMemory"
          | "ES2017.String"
          | "ES2017.TypedArrays"
          | "ES2017.ArrayBuffer"
          | "ES2018"
          | "ES2018.AsyncGenerator"
          | "ES2018.AsyncIterable"
          | "ES2018.Intl"
          | "ES2018.Promise"
          | "ES2018.Regexp"
          | "ES2019"
          | "ES2019.Array"
          | "ES2019.Intl"
          | "ES2019.Object"
          | "ES2019.String"
          | "ES2019.Symbol"
          | "ES2020"
          | "ES2020.BigInt"
          | "ES2020.Promise"
          | "ES2020.String"
          | "ES2020.Symbol.WellKnown"
          | "ESNext"
          | "ESNext.Array"
          | "ESNext.AsyncIterable"
          | "ESNext.BigInt"
          | "ESNext.Collection"
          | "ESNext.Intl"
          | "ESNext.Iterator"
          | "ESNext.Object"
          | "ESNext.Promise"
          | "ESNext.Regexp"
          | "ESNext.String"
          | "ESNext.Symbol"
          | "DOM"
          | "DOM.AsyncIterable"
          | "DOM.Iterable"
          | "ScriptHost"
          | "WebWorker"
          | "WebWorker.AsyncIterable"
          | "WebWorker.ImportScripts"
          | "Webworker.Iterable"
          | "ES7"
          | "ES2021"
          | "ES2020.SharedMemory"
          | "ES2020.Intl"
          | "ES2020.Date"
          | "ES2020.Number"
          | "ES2021.Promise"
          | "ES2021.String"
          | "ES2021.WeakRef"
          | "ESNext.WeakRef"
          | "ES2021.Intl"
          | "ES2022"
          | "ES2022.Array"
          | "ES2022.Error"
          | "ES2022.Intl"
          | "ES2022.Object"
          | "ES2022.String"
          | "ES2022.SharedMemory"
          | "ES2022.RegExp"
          | "ES2023"
          | "ES2023.Array"
          | "ES2024"
          | "ES2024.ArrayBuffer"
          | "ES2024.Collection"
          | "ES2024.Object"
          | "ES2024.Promise"
          | "ES2024.Regexp"
          | "ES2024.SharedMemory"
          | "ES2024.String"
          | "Decorators"
          | "Decorators.Legacy"
          | "ES2017.Date"
          | "ES2023.Collection"
          | "ESNext.Decorators"
          | "ESNext.Disposable"
          | "ESNext.Error"
          | "ESNext.Sharedmemory"
          | { [k: string]: unknown } & string
      )[];
      libReplacement?: boolean;
      listEmittedFiles?: boolean;
      listFiles?: boolean;
      listFilesOnly?: boolean;
      mapRoot?: string;
      maxNodeModuleJsDepth?: number;
      module?: (
          | "preserve"
          | "commonjs"
          | "amd"
          | "system"
          | "umd"
          | "es6"
          | "es2015"
          | "es2020"
          | "esnext"
          | "none"
          | "es2022"
          | "node16"
          | "node18"
          | "node20"
          | "nodenext"
          | { [k: string]: unknown }
      ) & (
          | "preserve"
          | "commonjs"
          | "amd"
          | "system"
          | "umd"
          | "es6"
          | "es2015"
          | "es2020"
          | "esnext"
          | "none"
          | "es2022"
          | "node16"
          | "node18"
          | "node20"
          | "nodenext"
          | { [k: string]: unknown } & string
      );
      moduleDetection?: "auto" | "legacy" | "force";
      moduleResolution?: (
          | "node16"
          | "nodenext"
          | "classic"
          | "node"
          | "node10"
          | "bundler"
          | { [k: string]: unknown }
      ) & (
          | "node16"
          | "nodenext"
          | "classic"
          | "node"
          | "node10"
          | "bundler"
          | { [k: string]: unknown } & string
      );
      moduleSuffixes?: string[];
      newLine?: ("crlf" | "lf" | { [k: string]: unknown }) & (
          "crlf"
          | "lf"
          | { [k: string]: unknown } & string
      );
      noCheck?: boolean;
      noEmit?: boolean;
      noEmitHelpers?: boolean;
      noEmitOnError?: boolean;
      noErrorTruncation?: boolean;
      noFallthroughCasesInSwitch?: boolean;
      noImplicitAny?: boolean;
      noImplicitOverride?: boolean;
      noImplicitReturns?: boolean;
      noImplicitThis?: boolean;
      noImplicitUseStrict?: boolean;
      noLib?: boolean;
      noPropertyAccessFromIndexSignature?: boolean;
      noResolve?: boolean;
      noStrictGenericChecks?: boolean;
      noUncheckedIndexedAccess?: boolean;
      noUncheckedSideEffectImports?: boolean;
      noUnusedLocals?: boolean;
      noUnusedParameters?: boolean;
      out?: string;
      outDir?: string;
      outFile?: string;
      paths?: { [k: string]: string[] };
      plugins?: { name?: string }[];
      preserveConstEnums?: boolean;
      preserveSymlinks?: boolean;
      preserveValueImports?: boolean;
      preserveWatchOutput?: boolean;
      pretty?: boolean;
      reactNamespace?: string;
      removeComments?: boolean;
      resolveJsonModule?: boolean;
      resolvePackageJsonExports?: boolean;
      resolvePackageJsonImports?: boolean;
      rewriteRelativeImportExtensions?: boolean;
      rootDir?: string;
      rootDirs?: string[];
      skipDefaultLibCheck?: boolean;
      skipLibCheck?: boolean;
      sourceMap?: boolean;
      sourceRoot?: string;
      strict?: boolean;
      strictBindCallApply?: boolean;
      strictBuiltinIteratorReturn?: boolean;
      strictFunctionTypes?: boolean;
      strictNullChecks?: boolean;
      strictPropertyInitialization?: boolean;
      stripInternal?: boolean;
      suppressExcessPropertyErrors?: boolean;
      suppressImplicitAnyIndexErrors?: boolean;
      target?: (
          | "es6"
          | "es2015"
          | "es2020"
          | "esnext"
          | "es2022"
          | "es3"
          | "es5"
          | "es2016"
          | "es2017"
          | "es2018"
          | "es2019"
          | "es2021"
          | "es2023"
          | "es2024"
          | { [k: string]: unknown }
      ) & (
          | "es6"
          | "es2015"
          | "es2020"
          | "esnext"
          | "es2022"
          | "es3"
          | "es5"
          | "es2016"
          | "es2017"
          | "es2018"
          | "es2019"
          | "es2021"
          | "es2023"
          | "es2024"
          | { [k: string]: unknown } & string
      );
      traceResolution?: boolean;
      tsBuildInfoFile?: string;
      typeRoots?: string[];
      types?: string[];
      useDefineForClassFields?: boolean;
      useUnknownInCatchVariables?: boolean;
      verbatimModuleSyntax?: boolean;
      watch?: boolean;
      watchDirectory?:
          | "fixedPollingInterval"
          | "dynamicPriorityPolling"
          | "useFsEvents"
          | "fixedChunkSizePolling";
      watchFile?: | "fixedPollingInterval"
      | "priorityPollingInterval"
      | "dynamicPriorityPolling"
      | "useFsEvents"
      | "fixedChunkSizePolling"
      | "useFsEventsOnParentDirectory";
  } & {
      allowArbitraryExtensions?: boolean;
      allowImportingTsExtensions?: boolean;
      allowJs?: boolean;
      allowSyntheticDefaultImports?: boolean;
      allowUmdGlobalAccess?: boolean;
      allowUnreachableCode?: boolean;
      allowUnusedLabels?: boolean;
      alwaysStrict?: boolean;
      assumeChangesOnlyAffectDirectDependencies?: boolean;
      baseUrl?: string;
      charset?: string;
      checkJs?: boolean;
      composite?: boolean;
      customConditions?: string[];
      declaration?: boolean;
      declarationDir?: string;
      declarationMap?: boolean;
      diagnostics?: boolean;
      disableReferencedProjectLoad?: boolean;
      disableSizeLimit?: boolean;
      disableSolutionSearching?: boolean;
      disableSourceOfProjectReferenceRedirect?: boolean;
      downlevelIteration?: boolean;
      emitBOM?: boolean;
      emitDeclarationOnly?: boolean;
      emitDecoratorMetadata?: boolean;
      erasableSyntaxOnly?: boolean;
      esModuleInterop?: boolean;
      exactOptionalPropertyTypes?: boolean;
      experimentalDecorators?: boolean;
      extendedDiagnostics?: boolean;
      fallbackPolling?: | "fixedPollingInterval"
      | "priorityPollingInterval"
      | "dynamicPriorityPolling"
      | "fixedInterval"
      | "priorityInterval"
      | "dynamicPriority"
      | "fixedChunkSize";
      forceConsistentCasingInFileNames?: boolean;
      generateCpuProfile?: string;
      importHelpers?: boolean;
      importsNotUsedAsValues?: "preserve"
      | "remove"
      | "error";
      incremental?: boolean;
      inlineSourceMap?: boolean;
      inlineSources?: boolean;
      isolatedDeclarations?: boolean;
      isolatedModules?: boolean;
      jsx?: "preserve" | "react" | "react-jsx" | "react-jsxdev" | "react-native";
      jsxFactory?: string;
      jsxFragmentFactory?: string;
      jsxImportSource?: string;
      keyofStringsOnly?: boolean;
      lib?: (
          | "ES5"
          | "ES6"
          | "ES2015"
          | "ES2015.Collection"
          | "ES2015.Core"
          | "ES2015.Generator"
          | "ES2015.Iterable"
          | "ES2015.Promise"
          | "ES2015.Proxy"
          | "ES2015.Reflect"
          | "ES2015.Symbol.WellKnown"
          | "ES2015.Symbol"
          | "ES2016"
          | "ES2016.Array.Include"
          | "ES2017"
          | "ES2017.Intl"
          | "ES2017.Object"
          | "ES2017.SharedMemory"
          | "ES2017.String"
          | "ES2017.TypedArrays"
          | "ES2017.ArrayBuffer"
          | "ES2018"
          | "ES2018.AsyncGenerator"
          | "ES2018.AsyncIterable"
          | "ES2018.Intl"
          | "ES2018.Promise"
          | "ES2018.Regexp"
          | "ES2019"
          | "ES2019.Array"
          | "ES2019.Intl"
          | "ES2019.Object"
          | "ES2019.String"
          | "ES2019.Symbol"
          | "ES2020"
          | "ES2020.BigInt"
          | "ES2020.Promise"
          | "ES2020.String"
          | "ES2020.Symbol.WellKnown"
          | "ESNext"
          | "ESNext.Array"
          | "ESNext.AsyncIterable"
          | "ESNext.BigInt"
          | "ESNext.Collection"
          | "ESNext.Intl"
          | "ESNext.Iterator"
          | "ESNext.Object"
          | "ESNext.Promise"
          | "ESNext.Regexp"
          | "ESNext.String"
          | "ESNext.Symbol"
          | "DOM"
          | "DOM.AsyncIterable"
          | "DOM.Iterable"
          | "ScriptHost"
          | "WebWorker"
          | "WebWorker.AsyncIterable"
          | "WebWorker.ImportScripts"
          | "Webworker.Iterable"
          | "ES7"
          | "ES2021"
          | "ES2020.SharedMemory"
          | "ES2020.Intl"
          | "ES2020.Date"
          | "ES2020.Number"
          | "ES2021.Promise"
          | "ES2021.String"
          | "ES2021.WeakRef"
          | "ESNext.WeakRef"
          | "ES2021.Intl"
          | "ES2022"
          | "ES2022.Array"
          | "ES2022.Error"
          | "ES2022.Intl"
          | "ES2022.Object"
          | "ES2022.String"
          | "ES2022.SharedMemory"
          | "ES2022.RegExp"
          | "ES2023"
          | "ES2023.Array"
          | "ES2024"
          | "ES2024.ArrayBuffer"
          | "ES2024.Collection"
          | "ES2024.Object"
          | "ES2024.Promise"
          | "ES2024.Regexp"
          | "ES2024.SharedMemory"
          | "ES2024.String"
          | "Decorators"
          | "Decorators.Legacy"
          | "ES2017.Date"
          | "ES2023.Collection"
          | "ESNext.Decorators"
          | "ESNext.Disposable"
          | "ESNext.Error"
          | "ESNext.Sharedmemory"
          | { [k: string]: unknown } & string
      )[];
      libReplacement?: boolean;
      listEmittedFiles?: boolean;
      listFiles?: boolean;
      listFilesOnly?: boolean;
      mapRoot?: string;
      maxNodeModuleJsDepth?: number;
      module?: (
          | "preserve"
          | "commonjs"
          | "amd"
          | "system"
          | "umd"
          | "es6"
          | "es2015"
          | "es2020"
          | "esnext"
          | "none"
          | "es2022"
          | "node16"
          | "node18"
          | "node20"
          | "nodenext"
          | { [k: string]: unknown }
      ) & (
          | "preserve"
          | "commonjs"
          | "amd"
          | "system"
          | "umd"
          | "es6"
          | "es2015"
          | "es2020"
          | "esnext"
          | "none"
          | "es2022"
          | "node16"
          | "node18"
          | "node20"
          | "nodenext"
          | { [k: string]: unknown } & string
      );
      moduleDetection?: "auto" | "legacy" | "force";
      moduleResolution?: (
          | "node16"
          | "nodenext"
          | "classic"
          | "node"
          | "node10"
          | "bundler"
          | { [k: string]: unknown }
      ) & (
          | "node16"
          | "nodenext"
          | "classic"
          | "node"
          | "node10"
          | "bundler"
          | { [k: string]: unknown } & string
      );
      moduleSuffixes?: string[];
      newLine?: ("crlf" | "lf" | { [k: string]: unknown }) & (
          "crlf"
          | "lf"
          | { [k: string]: unknown } & string
      );
      noCheck?: boolean;
      noEmit?: boolean;
      noEmitHelpers?: boolean;
      noEmitOnError?: boolean;
      noErrorTruncation?: boolean;
      noFallthroughCasesInSwitch?: boolean;
      noImplicitAny?: boolean;
      noImplicitOverride?: boolean;
      noImplicitReturns?: boolean;
      noImplicitThis?: boolean;
      noImplicitUseStrict?: boolean;
      noLib?: boolean;
      noPropertyAccessFromIndexSignature?: boolean;
      noResolve?: boolean;
      noStrictGenericChecks?: boolean;
      noUncheckedIndexedAccess?: boolean;
      noUncheckedSideEffectImports?: boolean;
      noUnusedLocals?: boolean;
      noUnusedParameters?: boolean;
      out?: string;
      outDir?: string;
      outFile?: string;
      paths?: { [k: string]: string[] };
      plugins?: { name?: string }[];
      preserveConstEnums?: boolean;
      preserveSymlinks?: boolean;
      preserveValueImports?: boolean;
      preserveWatchOutput?: boolean;
      pretty?: boolean;
      reactNamespace?: string;
      removeComments?: boolean;
      resolveJsonModule?: boolean;
      resolvePackageJsonExports?: boolean;
      resolvePackageJsonImports?: boolean;
      rewriteRelativeImportExtensions?: boolean;
      rootDir?: string;
      rootDirs?: string[];
      skipDefaultLibCheck?: boolean;
      skipLibCheck?: boolean;
      sourceMap?: boolean;
      sourceRoot?: string;
      strict?: boolean;
      strictBindCallApply?: boolean;
      strictBuiltinIteratorReturn?: boolean;
      strictFunctionTypes?: boolean;
      strictNullChecks?: boolean;
      strictPropertyInitialization?: boolean;
      stripInternal?: boolean;
      suppressExcessPropertyErrors?: boolean;
      suppressImplicitAnyIndexErrors?: boolean;
      target?: (
          | "es6"
          | "es2015"
          | "es2020"
          | "esnext"
          | "es2022"
          | "es3"
          | "es5"
          | "es2016"
          | "es2017"
          | "es2018"
          | "es2019"
          | "es2021"
          | "es2023"
          | "es2024"
          | { [k: string]: unknown }
      ) & (
          | "es6"
          | "es2015"
          | "es2020"
          | "esnext"
          | "es2022"
          | "es3"
          | "es5"
          | "es2016"
          | "es2017"
          | "es2018"
          | "es2019"
          | "es2021"
          | "es2023"
          | "es2024"
          | { [k: string]: unknown } & string
      );
      traceResolution?: boolean;
      tsBuildInfoFile?: string;
      typeRoots?: string[];
      types?: string[];
      useDefineForClassFields?: boolean;
      useUnknownInCatchVariables?: boolean;
      verbatimModuleSyntax?: boolean;
      watch?: boolean;
      watchDirectory?:
          | "fixedPollingInterval"
          | "dynamicPriorityPolling"
          | "useFsEvents"
          | "fixedChunkSizePolling";
      watchFile?: | "fixedPollingInterval"
      | "priorityPollingInterval"
      | "dynamicPriorityPolling"
      | "useFsEvents"
      | "fixedChunkSizePolling"
      | "useFsEventsOnParentDirectory";
  } & { [k: string]: unknown }

  JSON object to merge with TypeScript compilerOptions.

• Optionalemit?: boolean

  Emit output files into .ts-node directory.

• Optionalesm?: boolean

  Enable native ESM support.

  For details, see https://typestrong.org/ts-node/docs/imports#native-ecmascript-modules

• OptionalexperimentalReplAwait?: boolean

  Allows the usage of top level await in REPL.

  Uses node's implementation which accomplishes this with an AST syntax transformation.

  Enabled by default when tsconfig target is es2018 or above. Set to false to disable.

  Note: setting to true when tsconfig target is too low will throw an Error. Leave as undefined to get default, automatic behavior.

• OptionalexperimentalResolver?: boolean

  Enable experimental features that re-map imports and require calls to support: baseUrl, paths, rootDirs, .js to .ts file extension mappings, outDir to rootDir mappings for composite projects and monorepos.

  For details, see https://github.com/TypeStrong/ts-node/issues/1514

• OptionalexperimentalSpecifierResolution?: "node" | "explicit"

  Like node's --experimental-specifier-resolution, , but can also be set in your tsconfig.json for convenience.

  For details, see https://nodejs.org/dist/latest-v18.x/docs/api/esm.html#customizing-esm-specifier-resolution-algorithm

• Optionalfiles?: boolean

  Load "files" and "include" from tsconfig.json on startup.

  Default is to override tsconfig.json "files" and "include" to only include the entrypoint script.

• Optionalignore?: string[]

  Paths which should not be compiled.

  Each string in the array is converted to a regular expression via new RegExp() and tested against source paths prior to compilation.

  Source paths are normalized to posix-style separators, relative to the directory containing tsconfig.json or to cwd if no tsconfig.json is loaded.

  Default is to ignore all node_modules subdirectories.

• OptionalignoreDiagnostics?: (string | number)[]

  Ignore TypeScript warnings by diagnostic code.

• OptionallogError?: boolean

  Logs TypeScript errors to stderr instead of throwing exceptions.

• OptionalmoduleTypes?: TsNodeModuleTypes

• OptionalpreferTsExts?: boolean

  Re-order file extensions so that TypeScript imports are preferred.

  For example, when both index.js and index.ts exist, enabling this option causes require('./index') to resolve to index.ts instead of index.js

• Optionalpretty?: boolean

  Use pretty diagnostic formatter.

• Optionalrequire?: string[]

  Modules to require, like node's --require flag.

  If specified in tsconfig.json, the modules will be resolved relative to the tsconfig.json file.

  If specified programmatically, each input string should be pre-resolved to an absolute path for best results.

• Optionalscope?: boolean

  Scope compiler to files within scopeDir.

• OptionalscopeDir?: string

• OptionalskipIgnore?: boolean

  Skip ignore check, so that compilation will be attempted for all files with matching extensions.

• Optionalswc?: boolean

  Transpile with swc instead of the TypeScript compiler, and skip typechecking.

  Equivalent to setting both transpileOnly: true and transpiler: 'ts-node/transpilers/swc'

  For complete instructions: https://typestrong.org/ts-node/docs/transpilers

• OptionaltranspileOnly?: boolean

  Use TypeScript's faster transpileModule.

• Optionaltranspiler?: string | [string, { [k: string]: unknown }]

  Specify a custom transpiler for use with transpileOnly

• OptionaltypeCheck?: boolean

  DEPRECATED Specify type-check is enabled (e.g. transpileOnly == false).