Interface: UserConfig

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

Options for tsdown.

Extended by

• InlineConfig

Properties

alias?

optional alias: Record<string, string>;

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

---

attw?

optional attw: WithEnabled<AttwOptions>;

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

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

Default

false

See

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

---

banner?

optional banner: ChunkAddon;

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

---

bundle?

optional bundle: boolean;

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

Deprecated

Use unbundle instead.

Default

true

---

checks?

optional checks: ChecksOptions & object;

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

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?

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

true

---

cjsDefault?

optional cjsDefault: boolean;

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

Default

true

---

clean?

optional clean: boolean | string[];

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

Clean directories before build.

Default to output directory.

Default

true

---

copy?

optional copy:
  | CopyOptions
  | CopyOptionsFn;

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

Copy files to another directory.

Example

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

---

css?

optional css: CssOptions;

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

[experimental] CSS options.

---

customLogger?

optional customLogger: Logger;

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

Custom logger.

---

cwd?

optional cwd: string;

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

The working directory of the config file.

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

---

define?

optional define: Record<string, string>;

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

---

deps?

optional deps: DepsConfig;

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

Dependency handling options.

---

devtools?

optional devtools: WithEnabled<DevtoolsOptions>;

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

[experimental] Enable devtools.

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

This may slow down the build process significantly.

Default

false

---

dts?

optional dts: WithEnabled<DtsOptions>;

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

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.

---

entry?

optional entry: TsdownInputOption;

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

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

Supports glob patterns with negation to exclude files:

Example

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

---

env?

optional env: Record<string, any>;

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

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

Example

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

---

envFile?

optional envFile: string;

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

Path to env file providing compile-time env variables.

Example

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

---

envPrefix?

optional envPrefix: string | string[];

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

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

Default

'TSDOWN_'

---

exe?

optional exe: WithEnabled<ExeOptions>;

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

[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.5.0 and later, and is not supported in Bun or Deno.

---

exports?

optional exports: WithEnabled<ExportsOptions>;

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

Generate package exports for package.json.

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

---

external?

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

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

Deprecated

Use deps.neverBundle instead.

---

failOnWarn?

optional failOnWarn: boolean | CIOption;

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

If true, fails the build on warnings.

Default

'ci-only'

---

fixedExtension?

optional fixedExtension: boolean;

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

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.

---

footer?

optional footer: ChunkAddon;

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

---

format?

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

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

Output format(s). Defaults to ESM.

Usage with exe

If exe is enabled, the default format will depend on support level of SEA in the target Node.js version:

• If ESM SEA is supported, the default format will be ESM.
• If only CJS SEA is supported, the default format will be CJS.

---

fromVite?

optional fromVite: boolean | "vitest";

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

Reuse config from Vite or Vitest (experimental)

Default

false

---

globalName?

optional globalName: string;

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

---

globImport?

optional globImport: boolean;

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

import.meta.glob support.

See

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

Default

true

---

hash?

optional hash: boolean;

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

If enabled, appends hash to chunk filenames.

Default

true

---

hooks?

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

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

---

ignoreWatch?

optional ignoreWatch: Arrayable<string | RegExp>;

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

Files or patterns to not watch while in watch mode.

---

inlineOnly?

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

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

Deprecated

Use deps.onlyAllowBundle instead.

---

inputOptions?

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

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

Use with caution; ensure you understand the implications.

---

loader?

optional loader: ModuleTypes;

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

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

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

---

logLevel?

optional logLevel: LogLevel;

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

Log level.

Default

'info'

---

minify?

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

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

Default

false

---

name?

optional name: string;

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

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.

---

nodeProtocol?

optional nodeProtocol: boolean | "strip";

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

• If true, add node: prefix to built-in modules.
• If 'strip', strips the node: protocol prefix from import source.
• If false, does not modify the import source.

Default

false

Example

// With nodeProtocol enabled:
import('fs') // becomes import('node:fs')
// With nodeProtocol set to 'strip':
import('node:fs') // becomes import('fs')
// With nodeProtocol set to false:
import('node:fs') // remains import('node:fs')

---

noExternal?

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

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

Deprecated

Use deps.alwaysBundle instead.

---

onSuccess?

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

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

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

---

outDir?

optional outDir: string;

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

Default

'dist'

---

outExtensions?

optional outExtensions: OutExtensionFactory;

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

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

---

outputOptions?

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

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

Use with caution; ensure you understand the implications.

---

platform?

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

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

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

'node'

See

https://tsdown.dev/options/platform

---

plugins?

optional plugins: RolldownPluginOption<any>;

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

---

publicDir?

optional publicDir:
  | CopyOptions
  | CopyOptionsFn;

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

Deprecated

Alias for copy, will be removed in the future.

---

publint?

optional publint: WithEnabled<PublintOptions>;

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

Run publint after bundling. Requires publint to be installed.

Default

false

---

removeNodeProtocol?

optional removeNodeProtocol: boolean;

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

If enabled, strips the node: protocol prefix from import source.

Default

false

Deprecated

Use nodeProtocol: 'strip' instead.

Example

// With removeNodeProtocol enabled:
import('node:fs') // becomes import('fs')

---

report?

optional report: WithEnabled<ReportOptions>;

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

Enable size reporting after bundling.

Default

true

---

shims?

optional shims: boolean;

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

Default

false

---

skipNodeModulesBundle?

optional skipNodeModulesBundle: boolean;

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

Deprecated

Use deps.skipNodeModulesBundle instead.

Default

false

---

sourcemap?

optional sourcemap: Sourcemap;

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

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

false

---

target?

optional target: string | false | string[];

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

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'), 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

// Target a single environment
{ "target": "node18" }

// Target multiple environments
{ "target": ["node18", "es2020"] }

// Disable all syntax transformations
{ "target": false }

---

treeshake?

optional treeshake: boolean | TreeshakingOptions;

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

Configure tree shaking options.

See

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

Default

true

---

tsconfig?

optional tsconfig: string | boolean;

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

---

unbundle?

optional unbundle: boolean;

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

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

Default

false

---

unused?

optional unused: WithEnabled<UnusedOptions>;

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

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

Default

false

---

watch?

optional watch: boolean | Arrayable<string>;

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

Default

false

---

workspace?

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

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

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

---

write?

optional write: boolean;

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

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

Default

true