Interface: Options

Defined in: src/options/types.ts:104

Options for tsdown.

Properties

alias?

optional alias: Record<string, string>;

Defined in: src/options/types.ts:124

---

attw?

optional attw: boolean | AttwOptions;

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

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/options/types.ts:264

---

bundle?

optional bundle: boolean;

Defined in: src/options/types.ts:277

Deprecated

Use unbundle instead.

Default

true

---

cjsDefault?

optional cjsDefault: boolean;

Defined in: src/options/types.ts:302

Default

true

---

clean?

optional clean: boolean | string[];

Defined in: src/options/types.ts:258

Clean directories before build.

Default to output directory.

Default

true

---

config?

optional config: string | boolean;

Defined in: src/options/types.ts:352

Config file path

---

copy?

optional copy:
  | CopyOptions
  | CopyOptionsFn;

Defined in: src/options/types.ts:436

Copy files to another directory.

Example

;['src/assets', { from: 'src/assets', to: 'dist/assets' }]

---

customLogger?

optional customLogger: Logger;

Defined in: src/options/types.ts:347

Custom logger.

---

cwd?

optional cwd: string;

Defined in: src/options/types.ts:319

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/options/types.ts:182

---

dts?

optional dts: boolean | DtsOptions;

Defined in: src/options/types.ts:382

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

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

• 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: InputOption;

Defined in: src/options/types.ts:109

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

---

env?

optional env: Record<string, any>;

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

Compile-time env variables.

Example

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

---

exports?

optional exports: boolean | ExportsOptions;

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

[experimental] 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: ExternalOption;

Defined in: src/options/types.ts:111

---

failOnWarn?

optional failOnWarn: boolean;

Defined in: src/options/types.ts:343

If true, fails the build on warnings.

Default

false

---

filter?

optional filter: string | RegExp | string[];

Defined in: src/options/types.ts:451

Filter workspace packages. This option is only available in workspace mode.

---

fixedExtension?

optional fixedExtension: boolean;

Defined in: src/options/types.ts:285

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

Default

false

---

footer?

optional footer: ChunkAddon;

Defined in: src/options/types.ts:263

---

format?

optional format: ModuleFormat | ModuleFormat[];

Defined in: src/options/types.ts:246

Default

;['es']

---

fromVite?

optional fromVite: boolean | "vitest";

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

Reuse config from Vite or Vitest (experimental)

Default

false

---

globalName?

optional globalName: string;

Defined in: src/options/types.ts:247

---

hash?

optional hash: boolean;

Defined in: src/options/types.ts:297

If enabled, appends hash to chunk filenames.

Default

true

---

hooks?

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

Defined in: src/options/types.ts:438

---

ignoreWatch?

optional ignoreWatch: Arrayable<string | RegExp>;

Defined in: src/options/types.ts:364

---

inputOptions?

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

Defined in: src/options/types.ts:235

---

loader?

optional loader: ModuleTypes;

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

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/options/types.ts:338

Log level.

Default

'info'

---

minify?

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

Defined in: src/options/types.ts:262

Default

false

---

name?

optional name: string;

Defined in: src/options/types.ts:326

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/options/types.ts:231

• 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>
  | (id, importer) => undefined | null | boolean | void;

Defined in: src/options/types.ts:112

---

onSuccess?

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

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

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

---

outDir?

optional outDir: string;

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

Default

'dist'

---

outExtensions?

optional outExtensions: OutExtensionFactory;

Defined in: src/options/types.ts:291

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

---

outputOptions?

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

Defined in: src/options/types.ts:304

---

platform?

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

Defined in: src/options/types.ts:138

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/options/types.ts:233

---

publicDir?

optional publicDir:
  | CopyOptions
  | CopyOptionsFn;

Defined in: src/options/types.ts:424

Deprecated

Alias for copy, will be removed in the future.

---

publint?

optional publint: boolean | PublintOptions;

Defined in: src/options/types.ts:396

Run publint after bundling. Requires publint to be installed.

Default

false

---

removeNodeProtocol?

optional removeNodeProtocol: boolean;

Defined in: src/options/types.ts:213

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: boolean | ReportOptions;

Defined in: src/options/types.ts:411

Enable size reporting after bundling.

Default

true

---

shims?

optional shims: boolean;

Defined in: src/options/types.ts:185

Default

false

---

silent?

optional silent: boolean;

Defined in: src/options/types.ts:332

Default

false

Deprecated

Use logLevel instead.

---

skipNodeModulesBundle?

optional skipNodeModulesBundle: boolean;

Defined in: src/options/types.ts:122

Skip bundling node_modules.

Default

false

---

sourcemap?

optional sourcemap: Sourcemap;

Defined in: src/options/types.ts:251

Default

false

---

target?

optional target: string | false | string[];

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

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;

Defined in: src/options/types.ts:190

Default

true

---

tsconfig?

optional tsconfig: string | boolean;

Defined in: src/options/types.ts:125

---

unbundle?

optional unbundle: boolean;

Defined in: src/options/types.ts:271

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

Default

false

---

unused?

optional unused: boolean | UnusedOptions;

Defined in: src/options/types.ts:389

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

Default

false

---

watch?

optional watch: boolean | Arrayable<string>;

Defined in: src/options/types.ts:363

Default

false

---

workspace?

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

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

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