Interface: InlineConfig

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

Options for tsdown.

Extends

• UserConfig

Properties

alias?

optional alias: Record<string, string>;

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

Inherited from

UserConfig.alias

---

attw?

optional attw: WithEnabled<AttwOptions>;

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

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

Default

false

See

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

Inherited from

UserConfig.attw

---

banner?

optional banner: ChunkAddon;

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

Inherited from

UserConfig.banner

---

bundle?

optional bundle: boolean;

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

Deprecated

Use unbundle instead.

Default

true

Inherited from

UserConfig.bundle

---

checks?

optional checks: ChecksOptions & object;

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

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

Default

true

Inherited from

UserConfig.cjsDefault

---

clean?

optional clean: boolean | string[];

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

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

Config file path

---

configLoader?

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

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

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

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

[experimental] CSS options.

Inherited from

UserConfig.css

---

customLogger?

optional customLogger: Logger;

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

Custom logger.

Inherited from

UserConfig.customLogger

---

cwd?

optional cwd: string;

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

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

Inherited from

UserConfig.define

---

devtools?

optional devtools: WithEnabled<DevtoolsOptions>;

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

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

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.

Inherited from

UserConfig.dts

---

entry?

optional entry: TsdownInputOption;

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

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

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

Example

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

Inherited from

UserConfig.env

---

envFile?

optional envFile: string;

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

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

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

Default

'TSDOWN_'

Inherited from

UserConfig.envPrefix

---

exports?

optional exports: WithEnabled<ExportsOptions>;

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

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

Inherited from

UserConfig.external

---

failOnWarn?

optional failOnWarn: boolean | CIOption;

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

If true, fails the build on warnings.

Default

'ci-only'

Inherited from

UserConfig.failOnWarn

---

filter?

optional filter: RegExp | Arrayable<string>;

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

Filter configs by cwd or name.

---

fixedExtension?

optional fixedExtension: boolean;

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

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

---

footer?

optional footer: ChunkAddon;

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

Inherited from

UserConfig.footer

---

format?

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

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

Default

'es'

Inherited from

UserConfig.format

---

fromVite?

optional fromVite: boolean | "vitest";

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

Reuse config from Vite or Vitest (experimental)

Default

false

Inherited from

UserConfig.fromVite

---

globalName?

optional globalName: string;

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

Inherited from

UserConfig.globalName

---

globImport?

optional globImport: boolean;

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

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

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

Inherited from

UserConfig.hooks

---

ignoreWatch?

optional ignoreWatch: Arrayable<string | RegExp>;

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

Files or patterns to not watch while in watch mode.

Inherited from

UserConfig.ignoreWatch

---

inlineOnly?

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

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

Bundle only the dependencies listed here; throw an error if any others are missing.

• undefined (default): Show warnings for bundled dependencies.
• false: Suppress all warnings about inlineOnly option.

Note: Be sure to include all required sub-dependencies as well.

Inherited from

UserConfig.inlineOnly

---

inputOptions?

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

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

Use with caution; ensure you understand the implications.

Inherited from

UserConfig.inputOptions

---

loader?

optional loader: ModuleTypes;

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

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

Inherited from

UserConfig.loader

---

logLevel?

optional logLevel: LogLevel;

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

Log level.

Default

'info'

Inherited from

UserConfig.logLevel

---

minify?

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

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

Default

false

Inherited from

UserConfig.minify

---

name?

optional name: string;

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

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

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

Inherited from

UserConfig.noExternal

---

onSuccess?

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

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

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

Default

'dist'

Inherited from

UserConfig.outDir

---

outExtensions?

optional outExtensions: OutExtensionFactory;

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

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

Use with caution; ensure you understand the implications.

Inherited from

UserConfig.outputOptions

---

platform?

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

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

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

Inherited from

UserConfig.plugins

---

publicDir?

optional publicDir:
  | CopyOptions
  | CopyOptionsFn;

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

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

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

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

Enable size reporting after bundling.

Default

true

Inherited from

UserConfig.report

---

shims?

optional shims: boolean;

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

Default

false

Inherited from

UserConfig.shims

---

skipNodeModulesBundle?

optional skipNodeModulesBundle: boolean;

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

Skip bundling node_modules.

Default

false

Inherited from

UserConfig.skipNodeModulesBundle

---

sourcemap?

optional sourcemap: Sourcemap;

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

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

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 }

Inherited from

UserConfig.target

---

treeshake?

optional treeshake: boolean | TreeshakingOptions;

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

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

Inherited from

UserConfig.tsconfig

---

unbundle?

optional unbundle: boolean;

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

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

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

Default

false

Inherited from

UserConfig.watch

---

workspace?

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

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

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

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

Default

true

Inherited from

UserConfig.write