Interface: InlineConfig

Options for tsdown.

Extends

UserConfig

Properties

alias?

optional alias?: Record<string, string>;

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

Inherited from

UserConfig.alias

attw?

optional attw?: WithEnabled<AttwOptions>;

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

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

Default

false

See

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

Inherited from

UserConfig.attw

optional banner?: ChunkAddon;

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

Inherited from

UserConfig.banner

bundle?

optional bundle?: boolean;

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

Deprecated

Use unbundle instead.

Default

true

Inherited from

UserConfig.bundle

checks?

optional checks?: ChecksOptions & object;

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

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

Inherited from

UserConfig.checks

cjsDefault?

optional cjsDefault?: boolean;

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

Default

true

Inherited from

UserConfig.cjsDefault

clean?

optional clean?: boolean | string[];

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

Clean directories before build.

Default to output directory.

Default

true

Inherited from

UserConfig.clean

config?

optional config?: string | boolean;

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

Config file path

configLoader?

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

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

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

Default

'auto'

copy?

optional copy?:
  | CopyOptions
  | CopyOptionsFn;

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

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

Inherited from

UserConfig.copy

css?

optional css?: CssOptions;

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

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

Inherited from

UserConfig.css

customLogger?

optional customLogger?: Logger;

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

Custom logger.

Inherited from

UserConfig.customLogger

cwd?

optional cwd?: string;

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

The working directory of the config file.

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

Inherited from

UserConfig.cwd

define?

optional define?: Record<string, string>;

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

Inherited from

UserConfig.define

deps?

optional deps?: DepsConfig;

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

Dependency handling options.

Inherited from

UserConfig.deps

devtools?

optional devtools?: WithEnabled<DevtoolsOptions>;

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

[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

Inherited from

UserConfig.devtools

dts?

optional dts?: WithEnabled<DtsOptions>;

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

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?

optional entry?: TsdownInputOption;

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

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

Inherited from

UserConfig.entry

env?

optional env?: Record<string, any>;

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

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

Example

json

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

Inherited from

UserConfig.env

envFile?

optional envFile?: string;

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

Path to env file providing compile-time env variables.

Example

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

Inherited from

UserConfig.envFile

envPrefix?

optional envPrefix?: string | string[];

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

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

Default

'TSDOWN_'

Inherited from

UserConfig.envPrefix

exe?

optional exe?: WithEnabled<ExeOptions>;

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

[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.

Inherited from

UserConfig.exe

exports?

optional exports?: WithEnabled<ExportsOptions>;

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

Generate package exports for package.json.

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

Inherited from

UserConfig.exports

external?

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

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

Deprecated

Use deps.neverBundle instead.

Inherited from

UserConfig.external

failOnWarn?

optional failOnWarn?: boolean | CIOption;

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

If true, fails the build on warnings.

Default

false

Inherited from

UserConfig.failOnWarn

filter?

optional filter?: RegExp | Arrayable<string>;

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

Filter configs by cwd or name.

fixedExtension?

optional fixedExtension?: boolean;

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

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.

Inherited from

UserConfig.fixedExtension

optional footer?: ChunkAddon;

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

Inherited from

UserConfig.footer

format?

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

Output format(s). Available formats are

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

Defaults to ESM.

Inherited from

UserConfig.format

fromVite?

optional fromVite?: boolean | "vitest";

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

Reuse config from Vite or Vitest (experimental)

Default

false

Inherited from

UserConfig.fromVite

globalName?

optional globalName?: string;

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

Inherited from

UserConfig.globalName

globImport?

optional globImport?: boolean;

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

import.meta.glob support.

See

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

Default

true

Inherited from

UserConfig.globImport

hash?

optional hash?: boolean;

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

If enabled, appends hash to chunk filenames.

Default

true

Inherited from

UserConfig.hash

hooks?

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

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

Inherited from

UserConfig.hooks

ignoreWatch?

optional ignoreWatch?: Arrayable<string | RegExp>;

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

Files or patterns to not watch while in watch mode.

Inherited from

UserConfig.ignoreWatch

injectStyle?

optional injectStyle?: boolean;

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

Deprecated

Use css.inject instead.

Inherited from

UserConfig.injectStyle

inlineOnly?

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

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

Deprecated

Use deps.onlyBundle instead.

Inherited from

UserConfig.inlineOnly

inputOptions?

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

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

Use with caution; ensure you understand the implications.

Inherited from

UserConfig.inputOptions

loader?

optional loader?: ModuleTypes;

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

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?

optional logLevel?: LogLevel;

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

Log level.

Default

'info'

Inherited from

UserConfig.logLevel

minify?

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

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

Default

false

Inherited from

UserConfig.minify

name?

optional name?: string;

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

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?

optional nodeProtocol?: boolean | "strip";

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

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

Inherited from

UserConfig.nodeProtocol

noExternal?

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

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

Deprecated

Use deps.alwaysBundle instead.

Inherited from

UserConfig.noExternal

onSuccess?

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

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

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

Inherited from

UserConfig.onSuccess

outDir?

optional outDir?: string;

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

Default

'dist'

Inherited from

UserConfig.outDir

outExtensions?

optional outExtensions?: OutExtensionFactory;

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

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

Inherited from

UserConfig.outExtensions

outputOptions?

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

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

Use with caution; ensure you understand the implications.

Inherited from

UserConfig.outputOptions

platform?

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

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

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

Inherited from

UserConfig.platform

plugins?

optional plugins?: RolldownPluginOption<any>;

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

Inherited from

UserConfig.plugins

publicDir?

optional publicDir?:
  | CopyOptions
  | CopyOptionsFn;

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

Deprecated

Alias for copy, will be removed in the future.

Inherited from

UserConfig.publicDir

publint?

optional publint?: WithEnabled<PublintOptions>;

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

Run publint after bundling. Requires publint to be installed.

Default

false

Inherited from

UserConfig.publint

removeNodeProtocol?

optional removeNodeProtocol?: boolean;

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

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

Inherited from

UserConfig.removeNodeProtocol

report?

optional report?: WithEnabled<ReportOptions>;

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

Enable size reporting after bundling.

Default

true

Inherited from

UserConfig.report

root?

optional root?: string;

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

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?

optional shims?: boolean;

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

Default

false

Inherited from

UserConfig.shims

skipNodeModulesBundle?

optional skipNodeModulesBundle?: boolean;

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

Deprecated

Use deps.skipNodeModulesBundle instead.

Default

false

Inherited from

UserConfig.skipNodeModulesBundle

sourcemap?

optional sourcemap?: Sourcemap;

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

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

Inherited from

UserConfig.sourcemap

target?

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

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

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

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?

optional treeshake?: boolean | TreeshakingOptions;

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

Configure tree shaking options.

See

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

Default

true

Inherited from

UserConfig.treeshake

tsconfig?

optional tsconfig?: string | boolean;

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

Inherited from

UserConfig.tsconfig

unbundle?

optional unbundle?: boolean;

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

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

Default

false

Inherited from

UserConfig.unbundle

unused?

optional unused?: WithEnabled<UnusedOptions>;

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

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

Default

false

Inherited from

UserConfig.unused

watch?

optional watch?: boolean | Arrayable<string>;

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

Default

false

Inherited from

UserConfig.watch

workspace?

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

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

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

Inherited from

UserConfig.workspace

write?

optional write?: boolean;

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

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

Default

true

Inherited from

UserConfig.write

Interface: InlineConfig ​

Extends ​

Properties ​

alias? ​

Inherited from ​

attw? ​

Default ​

See ​

Inherited from ​

banner? ​

Inherited from ​

bundle? ​

Deprecated ​

Default ​

Inherited from ​

checks? ​

Type Declaration ​

legacyCjs? ​

Default ​

Inherited from ​

cjsDefault? ​

Default ​

Inherited from ​

clean? ​

Default ​

Inherited from ​

config? ​

configLoader? ​

Default ​

copy? ​

Example ​

Inherited from ​

css? ​

Inherited from ​

customLogger? ​

Inherited from ​

cwd? ​

Inherited from ​

define? ​

Inherited from ​

deps? ​

Inherited from ​

devtools? ​

Default ​

Inherited from ​

dts? ​

Inherited from ​

entry? ​

Example ​

Inherited from ​

env? ​

Example ​

Inherited from ​

envFile? ​

Example ​

Inherited from ​

envPrefix? ​

Default ​

Inherited from ​

exe? ​

Inherited from ​

exports? ​

Inherited from ​

external? ​

Deprecated ​

Inherited from ​

failOnWarn? ​

Default ​

Inherited from ​

filter? ​

fixedExtension? ​

Inherited from ​

footer? ​

Inherited from ​

format? ​

Inherited from ​

fromVite? ​

Default ​

Inherited from ​

globalName? ​

Interface: InlineConfig

Extends

Properties

alias?

Inherited from

attw?

Default

See

Inherited from

banner?

Inherited from

bundle?

Deprecated

Default

Inherited from

checks?

Type Declaration

legacyCjs?

Default

Inherited from

cjsDefault?

Default

Inherited from

clean?

Default

Inherited from

config?

configLoader?

Default

copy?

Example

Inherited from

css?

Inherited from

customLogger?

Inherited from

cwd?

Inherited from

define?

Inherited from

deps?

Inherited from

devtools?

Default

Inherited from

dts?

Inherited from

entry?

Example

Inherited from

env?

Example

Inherited from

envFile?

Example

Inherited from

envPrefix?

Default

Inherited from

exe?

Inherited from

exports?

Inherited from

external?

Deprecated

Inherited from

failOnWarn?

Default

Inherited from

filter?

fixedExtension?

Inherited from

footer?

Inherited from

format?

Inherited from

fromVite?

Default

Inherited from

globalName?