tsdown

English

简体中文
Русский (community)

English

简体中文
Русский (community)

Appearance

Interface: InlineConfig ​

Defined in: src/config/types.ts:703

Options for tsdown.

Extends ​

Properties ​

alias? ​

ts
optional alias?: Record<string, string>;

Defined in: src/config/types.ts:212

Inherited from ​

UserConfig.alias

attw? ​

ts
optional attw?: WithEnabled<AttwOptions>;

Defined in: src/config/types.ts:612

Run arethetypeswrong after bundling. Requires @arethetypeswrong/core to be installed.

Default ​

ts
false

See ​

https://github.com/arethetypeswrong/arethetypeswrong.github.io

Inherited from ​

UserConfig.attw

ts
optional banner?: ChunkAddon;

Defined in: src/config/types.ts:448

Inherited from ​

UserConfig.banner

bundle? ​

ts
optional bundle?: boolean;

Defined in: src/config/types.ts:471

Deprecated ​

Use unbundle instead.

Default ​

ts
true

Inherited from ​

UserConfig.bundle

checks? ​

ts
optional checks?: ChecksOptions & object;

Defined in: src/config/types.ts:379

Controls which warnings are emitted during the build process. Each option can be set to true (emit warning) or false (suppress warning).

Type Declaration ​

legacyCjs? ​
ts
optional legacyCjs?: boolean;

If the config includes the cjs format and one of its target >= node 20.19.0 / 22.12.0, warn the user about the deprecation of CommonJS.

Default ​
ts
true

Inherited from ​

UserConfig.checks

cjsDefault? ​

ts
optional cjsDefault?: boolean;

Defined in: src/config/types.ts:500

Default ​

ts
true

Inherited from ​

UserConfig.cjsDefault

clean? ​

ts
optional clean?: boolean | string[];

Defined in: src/config/types.ts:442

Clean directories before build.

Default to output directory.

Default ​

ts
true

Inherited from ​

UserConfig.clean

config? ​

ts
optional config?: string | boolean;

Defined in: src/config/types.ts:707

Config file path

configLoader? ​

ts
optional configLoader?: "tsx" | "auto" | "native" | "unrun";

Defined in: src/config/types.ts:713

Config loader to use. It can only be set via CLI or API.

Default ​

ts
'auto'

copy? ​

ts
optional copy?:
  | CopyOptions
  | CopyOptionsFn;

Defined in: src/config/types.ts:667

Copy files to another directory.

Example ​

ts
;[
  'src/assets',
  'src/env.d.ts',
  'src/styles/**/*.css',
  { from: 'src/assets', to: 'dist/assets' },
  { from: 'src/styles/**/*.css', to: 'dist', flatten: true },
]

Inherited from ​

UserConfig.copy

css? ​

ts
optional css?: CssOptions;

Defined in: src/config/types.ts:641

[experimental] CSS options. Requires @tsdown/css to be installed.

Inherited from ​

UserConfig.css

customLogger? ​

ts
optional customLogger?: Logger;

Defined in: src/config/types.ts:544

Custom logger.

Inherited from ​

UserConfig.customLogger

cwd? ​

ts
optional cwd?: string;

Defined in: src/config/types.ts:522

The working directory of the config file.

  • Defaults to process.cwd | process.cwd() for root config.
  • Defaults to the package directory for workspace config.

Default ​

ts
process.cwd()

Inherited from ​

UserConfig.cwd

define? ​

ts
optional define?: Record<string, string>;

Defined in: src/config/types.ts:287

Inherited from ​

UserConfig.define

deps? ​

ts
optional deps?: DepsConfig;

Defined in: src/config/types.ts:192

Dependency handling options.

Inherited from ​

UserConfig.deps

devtools? ​

ts
optional devtools?: WithEnabled<DevtoolsOptions>;

Defined in: src/config/types.ts:570

[experimental] Enable devtools.

DevTools is still under development, and this is for early testers only.

This may slow down the build process significantly.

Default ​

ts
false

Inherited from ​

UserConfig.devtools

dts? ​

ts
optional dts?: WithEnabled<DtsOptions>;

Defined in: src/config/types.ts:589

Enables generation of TypeScript declaration files (.d.ts).

By default, this option is auto-detected based on your project's package.json:

  • If exe is enabled, declaration file generation is disabled by default.
  • If the types field is present, or if the main exports contains a types entry, declaration file generation is enabled by default.
  • Otherwise, declaration file generation is disabled by default.

Inherited from ​

UserConfig.dts

entry? ​

ts
optional entry?: TsdownInputOption;

Defined in: src/config/types.ts:187

Defaults to 'src/index.ts' if it exists.

Supports glob patterns with negation to exclude files:

Example ​

ts
entry: {
  "hooks/*": ["./src/hooks/*.ts", "!./src/hooks/index.ts"],
}

Default ​

ts
{
  index: 'src/index.ts'
}

Inherited from ​

UserConfig.entry

env? ​

ts
optional env?: Record<string, any>;

Defined in: src/config/types.ts:275

Compile-time env variables, which can be accessed via import.meta.env or process.env.

Example ​

json
{
  "DEBUG": true,
  "NODE_ENV": "production"
}

Default ​

ts
{
}

Inherited from ​

UserConfig.env

envFile? ​

ts
optional envFile?: string;

Defined in: src/config/types.ts:281

Path to env file providing compile-time env variables.

Example ​

ts
`.env`, `.env.production`, etc.

Inherited from ​

UserConfig.envFile

envPrefix? ​

ts
optional envPrefix?: string | string[];

Defined in: src/config/types.ts:286

When loading env variables from envFile, only include variables with these prefixes.

Default ​

ts
'TSDOWN_'

Inherited from ​

UserConfig.envPrefix

exe? ​

ts
optional exe?: WithEnabled<ExeOptions>;

Defined in: src/config/types.ts:681

[experimental] Bundle as executable using Node.js SEA (Single Executable Applications).

This will bundle the output into a single executable file using Node.js SEA. Note that this is only supported on Node.js 25.7.0 and later, and is not supported in Bun or Deno.

Default ​

ts
false

Inherited from ​

UserConfig.exe

exports? ​

ts
optional exports?: WithEnabled<ExportsOptions>;

Defined in: src/config/types.ts:635

Generate package exports for package.json.

This will set the main, module, types, exports fields in package.json to point to the generated files.

Default ​

ts
false

Inherited from ​

UserConfig.exports

external? ​

ts
optional external?: string | RegExp | (string | RegExp)[] | ExternalOptionFunction;

Defined in: src/config/types.ts:197

Deprecated ​

Use deps.neverBundle instead.

Inherited from ​

UserConfig.external

failOnWarn? ​

ts
optional failOnWarn?: boolean | CIOption;

Defined in: src/config/types.ts:540

If true, fails the build on warnings.

Default ​

ts
false

Inherited from ​

UserConfig.failOnWarn

filter? ​

ts
optional filter?: RegExp | Arrayable<string>;

Defined in: src/config/types.ts:718

Filter configs by cwd or name.

fixedExtension? ​

ts
optional fixedExtension?: boolean;

Defined in: src/config/types.ts:483

Use a fixed extension for output files. The extension will always be .cjs or .mjs. Otherwise, it will depend on the package type.

Defaults to true if platform is set to node, false otherwise.

Default ​

ts
platform === 'node'

Inherited from ​

UserConfig.fixedExtension

ts
optional footer?: ChunkAddon;

Defined in: src/config/types.ts:447

Inherited from ​

UserConfig.footer

format? ​

ts
optional format?:
  | "es" | "cjs" | "iife" | "umd" | "commonjs" | "module" | "esm"
  | ("es" | "cjs" | "iife" | "umd" | "commonjs" | "module" | "esm")[]
| Partial<Record<"es" | "cjs" | "iife" | "umd" | "commonjs" | "module" | "esm", Partial<ResolvedConfig>>>;

Defined in: src/config/types.ts:414

Output format(s). Available formats are

  • esm: ESM
  • cjs: CommonJS
  • iife: IIFE
  • umd: UMD

Default ​

ts
'esm'

Inherited from ​

UserConfig.format

fromVite? ​

ts
optional fromVite?: boolean | "vitest";

Defined in: src/config/types.ts:550

Reuse config from Vite or Vitest (experimental)

Default ​

ts
false

Inherited from ​

UserConfig.fromVite

globalName? ​

ts
optional globalName?: string;

Defined in: src/config/types.ts:415

Inherited from ​

UserConfig.globalName

globImport? ​

ts
optional globImport?: boolean;

Defined in: src/config/types.ts:625

import.meta.glob support.

See ​

https://vite.dev/guide/features.html#glob-import

Default ​

ts
true

Inherited from ​

UserConfig.globImport

hash? ​

ts
optional hash?: boolean;

Defined in: src/config/types.ts:495

If enabled, appends hash to chunk filenames.

Default ​

ts
true

Inherited from ​

UserConfig.hash

hooks? ​

ts
optional hooks?:
  | Partial<TsdownHooks>
  | ((hooks) => Awaitable<void>);

Defined in: src/config/types.ts:669

Inherited from ​

UserConfig.hooks

ignoreWatch? ​

ts
optional ignoreWatch?: Arrayable<string | RegExp>;

Defined in: src/config/types.ts:559

Files or patterns to not watch while in watch mode.

Inherited from ​

UserConfig.ignoreWatch

injectStyle? ​

ts
optional injectStyle?: boolean;

Defined in: src/config/types.ts:646

Deprecated ​

Use CssOptions.inject | css.inject instead.

Inherited from ​

UserConfig.injectStyle

inlineOnly? ​

ts
optional inlineOnly?: false | Arrayable<string | RegExp>;

Defined in: src/config/types.ts:205

Deprecated ​

Use deps.onlyBundle instead.

Inherited from ​

UserConfig.inlineOnly

inputOptions? ​

ts
optional inputOptions?:
  | InputOptions
  | ((options, format, context) => Awaitable<void | InputOptions | null>);

Defined in: src/config/types.ts:395

Use with caution; ensure you understand the implications.

Inherited from ​

UserConfig.inputOptions

loader? ​

ts
optional loader?: ModuleTypes;

Defined in: src/config/types.ts:310

Sets how input files are processed. For example, use 'js' to treat files as JavaScript or 'base64' for images. Lets you import or require files like images or fonts.

Example ​

json
{ ".jpg": "asset", ".png": "base64" }

Inherited from ​

UserConfig.loader

logLevel? ​

ts
optional logLevel?: LogLevel;

Defined in: src/config/types.ts:535

Log level.

Default ​

ts
'info'

Inherited from ​

UserConfig.logLevel

maxParallel? ​

ts
optional maxParallel?: number;

Defined in: src/config/types.ts:700

Limit how many config builds can run at the same time.

This is especially useful in workspace mode where each package can start expensive child processes (e.g. tsgo via dts.tsgo: true). Without a limit, all configs start building concurrently, which can spawn many subprocesses and exhaust system resources.

When set to a positive integer, at most that many builds run in parallel. When omitted or undefined, all builds run concurrently (existing behavior).

Inherited from ​

UserConfig.maxParallel

minify? ​

ts
optional minify?: boolean | "dce-only" | MinifyOptions;

Defined in: src/config/types.ts:446

Default ​

ts
false

Inherited from ​

UserConfig.minify

name? ​

ts
optional name?: string;

Defined in: src/config/types.ts:529

The name to show in CLI output. This is useful for monorepos or workspaces. When using workspace mode, this option defaults to the package name from package.json. In non-workspace mode, this option must be set explicitly for the name to show in the CLI output.

Inherited from ​

UserConfig.name

nodeProtocol? ​

ts
optional nodeProtocol?: boolean | "strip";

Defined in: src/config/types.ts:374

Control whether built-in Node.js module imports use the node: protocol.

  • true: Add the node: prefix to built-in module imports.
  • 'strip': Remove the node: prefix from built-in module imports.
  • false: Do not transform built-in module imports.

Default ​

ts
false

Examples ​

`nodeProtocol: true` — add the `node:` prefix
ts
// Input
import 'fs'

// Output
import 'node:fs'
`nodeProtocol: 'strip'` — remove the `node:` prefix
ts
// Input
import 'node:fs'

// Output
import 'fs'
`nodeProtocol: false` — do not transform imports
ts
// Input
import 'node:fs'

// Output
import 'node:fs'

Inherited from ​

UserConfig.nodeProtocol

noExternal? ​

ts
optional noExternal?:
  | Arrayable<string | RegExp>
  | NoExternalFn;

Defined in: src/config/types.ts:201

Deprecated ​

Use deps.alwaysBundle instead.

Inherited from ​

UserConfig.noExternal

onSuccess? ​

ts
optional onSuccess?: string | ((config, signal) => void | Promise<void>);

Defined in: src/config/types.ts:577

You can specify command to be executed after a successful build, specially useful for Watch mode

Inherited from ​

UserConfig.onSuccess

outDir? ​

ts
optional outDir?: string;

Defined in: src/config/types.ts:419

Default ​

ts
'dist'

Inherited from ​

UserConfig.outDir

outExtensions? ​

ts
optional outExtensions?: OutExtensionFactory;

Defined in: src/config/types.ts:489

Custom extensions for output files. fixedExtension will be overridden by this option.

Inherited from ​

UserConfig.outExtensions

outputOptions? ​

ts
optional outputOptions?:
  | OutputOptions
  | ((options, format, context) => Awaitable<void | OutputOptions | null>);

Defined in: src/config/types.ts:505

Use with caution; ensure you understand the implications.

Inherited from ​

UserConfig.outputOptions

platform? ​

ts
optional platform?: "node" | "neutral" | "browser";

Defined in: src/config/types.ts:230

Specifies the target runtime platform for the build.

  • node: Node.js and compatible runtimes (e.g., Deno, Bun). For CJS format, this is always set to node and cannot be changed.
  • neutral: A platform-agnostic target with no specific runtime assumptions.
  • browser: Web browsers.

Default ​

ts
'node'

See ​

https://tsdown.dev/options/platform

Inherited from ​

UserConfig.platform

plugins? ​

ts
optional plugins?: TsdownPluginOption;

Defined in: src/config/types.ts:390

Inherited from ​

UserConfig.plugins

publicDir? ​

ts
optional publicDir?:
  | CopyOptions
  | CopyOptionsFn;

Defined in: src/config/types.ts:652

Alias ​

copy

Deprecated ​

Alias for copy, will be removed in the future.

Inherited from ​

UserConfig.publicDir

publint? ​

ts
optional publint?: WithEnabled<PublintOptions>;

Defined in: src/config/types.ts:603

Run publint after bundling. Requires publint to be installed.

Default ​

ts
false

Inherited from ​

UserConfig.publint

removeNodeProtocol? ​

ts
optional removeNodeProtocol?: boolean;

Defined in: src/config/types.ts:330

Remove the node: prefix from built-in Node.js module imports. When enabled, rewrites import sources like node:fs to fs.

Default ​

ts
false

Deprecated ​

Use nodeProtocol: 'strip' instead.

Example ​

`removeNodeProtocol: true` — remove the `node:` prefix
ts
// Input
import 'node:fs'

// Output
import 'fs'

Inherited from ​

UserConfig.removeNodeProtocol

report? ​

ts
optional report?: WithEnabled<ReportOptions>;

Defined in: src/config/types.ts:618

Enable size reporting after bundling.

Default ​

ts
true

Inherited from ​

UserConfig.report

root? ​

ts
optional root?: string;

Defined in: src/config/types.ts:465

Specifies the root directory of input files, similar to TypeScript's rootDir. This determines the output directory structure.

By default, the root is computed as the common base directory of all entry files.

See ​

https://www.typescriptlang.org/tsconfig/#rootDir

Inherited from ​

UserConfig.root

shims? ​

ts
optional shims?: boolean;

Defined in: src/config/types.ts:292

Default ​

ts
false

Inherited from ​

UserConfig.shims

skipNodeModulesBundle? ​

ts
optional skipNodeModulesBundle?: boolean;

Defined in: src/config/types.ts:210

Deprecated ​

Use deps.skipNodeModulesBundle instead.

Default ​

ts
false

Inherited from ​

UserConfig.skipNodeModulesBundle

sourcemap? ​

ts
optional sourcemap?: Sourcemap;

Defined in: src/config/types.ts:435

Whether to generate source map files.

Note that this option will always be true if you have `declarationMap` option enabled in your tsconfig.json.

Default ​

ts
false

Inherited from ​

UserConfig.sourcemap

target? ​

ts
optional target?: string | false | string[];

Defined in: src/config/types.ts:261

Specifies the compilation target environment(s).

Determines the JavaScript version or runtime(s) for which the code should be compiled. If not set, defaults to the value of engines.node in your project's package.json. If no engines.node field exists, no syntax transformations are applied.

Accepts a single target (e.g., 'es2020', 'node18', 'baseline-widely-available'), an array of targets, or false to disable all transformations.

See ​

https://tsdown.dev/options/target#supported-targets for a list of valid targets and more details.

Examples ​

jsonc
// Target a single environment
{ "target": "node18" }
jsonc
// Target multiple environments
{ "target": ["node18", "es2020"] }
jsonc
// Disable all syntax transformations
{ "target": false }

Inherited from ​

UserConfig.target

treeshake? ​

ts
optional treeshake?: boolean | TreeshakingOptions;

Defined in: src/config/types.ts:299

Configure tree shaking options.

See ​

https://rolldown.rs/options/treeshake for more details.

Default ​

ts
true

Inherited from ​

UserConfig.treeshake

tsconfig? ​

ts
optional tsconfig?: string | boolean;

Defined in: src/config/types.ts:217

Default ​

ts
true

Inherited from ​

UserConfig.tsconfig

unbundle? ​

ts
optional unbundle?: boolean;

Defined in: src/config/types.ts:455

Determines whether unbundle is enabled. When set to true, the output files will mirror the input file structure.

Default ​

ts
false

Inherited from ​

UserConfig.unbundle

unused? ​

ts
optional unused?: WithEnabled<UnusedOptions>;

Defined in: src/config/types.ts:596

Enable unused dependencies check with unplugin-unused Requires unplugin-unused to be installed.

Default ​

ts
false

Inherited from ​

UserConfig.unused

watch? ​

ts
optional watch?: boolean | Arrayable<string>;

Defined in: src/config/types.ts:555

Default ​

ts
false

Inherited from ​

UserConfig.watch

workspace? ​

ts
optional workspace?: true | Arrayable<string> | Workspace;

Defined in: src/config/types.ts:687

[experimental] Enable workspace mode. This allows you to build multiple packages in a monorepo.

Inherited from ​

UserConfig.workspace

write? ​

ts
optional write?: boolean;

Defined in: src/config/types.ts:425

Whether to write the files to disk. This option is incompatible with watch mode.

Default ​

ts
true

Inherited from ​

UserConfig.write

Released under the MIT License.

Copyright © 2025-present VoidZero Inc. & Contributors