Interface: Options

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

Options for tsdown.

Properties

alias?

optional alias: Record<string, string>;

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

---

attw?

optional attw: boolean | AttwOptions;

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

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:400

---

bundle?

optional bundle: boolean;

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

Deprecated

Use unbundle instead.

Default

true;

---

clean?

optional clean: boolean | string[];

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

Clean directories before build.

Default to output directory.

Default

true;

---

config?

optional config: string | boolean;

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

Config file path

---

copy?

optional copy:
  | CopyOptions
  | CopyOptionsFn;

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

Copy files to another directory.

Example

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

---

cwd?

optional cwd: string;

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

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:192

---

dts?

optional dts: boolean | DtsOptions;

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

Emit TypeScript declaration files (.d.ts).

By default, this feature is auto-detected based on the presence of the types field in the package.json file.

• If the types field is present in package.json, declaration file emission is enabled.
• If the types field is absent, declaration file emission is disabled by default.

---

entry?

optional entry: InputOption;

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

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

---

env?

optional env: Record<string, any>;

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

Compile-time env variables.

Example

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

---

exports?

optional exports: boolean | ExportsOptions;

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

[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:109

---

filter?

optional filter: string | RegExp | string[];

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

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

---

fixedExtension?

optional fixedExtension: boolean;

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

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:399

---

format?

optional format: ModuleFormat | ModuleFormat[];

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

Default

["es"];

---

fromVite?

optional fromVite: boolean | "vitest";

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

Reuse config from Vite or Vitest (experimental)

Default

false;

---

globalName?

optional globalName: string;

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

---

hash?

optional hash: boolean;

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

If enabled, appends hash to chunk filenames.

Default

true;

---

hooks?

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

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

---

ignoreWatch?

optional ignoreWatch: string | string[];

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

---

inputOptions?

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

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

---

loader?

optional loader: ModuleTypes;

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

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" }

---

minify?

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

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

Default

false;

---

name?

optional name: string;

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

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:375

• 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:110

---

onSuccess?

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

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

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:143

Default

"dist";

---

outExtensions?

optional outExtensions: OutExtensionFactory;

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

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:216

---

platform?

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

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

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:226

---

publicDir?

optional publicDir:
  | CopyOptions
  | CopyOptionsFn;

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

Deprecated

Alias for copy, will be removed in the future.

---

publint?

optional publint: boolean | PublintOptions;

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

Run publint after bundling. Requires publint to be installed.

Default

false;

---

removeNodeProtocol?

optional removeNodeProtocol: boolean;

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

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:304

Enable size reporting after bundling.

Default

true;

---

shims?

optional shims: boolean;

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

Default

false;

---

silent?

optional silent: boolean;

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

Default

false;

---

skipNodeModulesBundle?

optional skipNodeModulesBundle: boolean;

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

Skip bundling node_modules.

Default

false;

---

sourcemap?

optional sourcemap: Sourcemap;

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

Default

false;

---

target?

optional target: string | false | string[];

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

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.

Accepts a single target (e.g., 'es2020', 'node18') or an array of targets.

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"] }

---

treeshake?

optional treeshake: boolean;

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

Default

true;

---

tsconfig?

optional tsconfig: string | boolean;

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

---

unbundle?

optional unbundle: boolean;

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

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:282

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

Default

false;

---

watch?

optional watch: string | boolean | string[];

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

Default

false;

---

workspace?

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

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

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