Interface: InlineConfig

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

Options for tsdown.

Extends

• UserConfig

Properties

alias?

optional alias: Record<string, string>;

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

Inherited from

UserConfig.alias

---

attw?

optional attw: WithEnabled<AttwOptions>;

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

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

Inherited from

UserConfig.banner

---

bundle?

optional bundle: boolean;

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

Deprecated

Use unbundle instead.

Default

true

Inherited from

UserConfig.bundle

---

cjsDefault?

optional cjsDefault: boolean;

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

Default

true

Inherited from

UserConfig.cjsDefault

---

clean?

optional clean: boolean | string[];

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

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

Config file path

---

configLoader?

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

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

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

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

---

customLogger?

optional customLogger: Logger;

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

Custom logger.

Inherited from

UserConfig.customLogger

---

cwd?

optional cwd: string;

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

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

---

debug?

optional debug: WithEnabled<DebugOptions>;

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

[experimental] Enable debug mode.

Both debug mode and Vite DevTools are still under development, and this is for early testers only.

This may slow down the build process significantly.

Default

false

Inherited from

UserConfig.debug

---

define?

optional define: Record<string, string>;

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

Inherited from

UserConfig.define

---

dts?

optional dts: WithEnabled<DtsOptions>;

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

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

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

Compile-time env variables.

Example

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

Inherited from

UserConfig.env

---

exports?

optional exports: WithEnabled<ExportsOptions>;

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

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: ExternalOption;

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

Inherited from

UserConfig.external

---

failOnWarn?

optional failOnWarn: boolean | CIOption;

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

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

Filter configs by cwd or name.

---

fixedExtension?

optional fixedExtension: boolean;

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

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

Inherited from

UserConfig.footer

---

format?

optional format:
  | ModuleFormat
  | Partial<Record<ModuleFormat, Partial<ResolvedConfig>>>
  | ModuleFormat[];

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

Default

'es'

Inherited from

UserConfig.format

---

fromVite?

optional fromVite: boolean | "vitest";

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

Reuse config from Vite or Vitest (experimental)

Default

false

Inherited from

UserConfig.fromVite

---

globalName?

optional globalName: string;

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

Inherited from

UserConfig.globalName

---

globImport?

optional globImport: boolean;

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

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

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

Inherited from

UserConfig.hooks

---

ignoreWatch?

optional ignoreWatch: Arrayable<string | RegExp>;

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

Files or patterns to not watch while in watch mode.

Inherited from

UserConfig.ignoreWatch

---

inlineOnly?

optional inlineOnly: Arrayable<string | RegExp>;

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

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

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

Use with caution; ensure you understand the implications.

Inherited from

UserConfig.inputOptions

---

loader?

optional loader: ModuleTypes;

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

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

Log level.

Default

'info'

Inherited from

UserConfig.logLevel

---

minify?

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

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

Default

false

Inherited from

UserConfig.minify

---

name?

optional name: string;

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

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

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

Inherited from

UserConfig.noExternal

---

onSuccess?

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

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

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

Default

'dist'

Inherited from

UserConfig.outDir

---

outExtensions?

optional outExtensions: OutExtensionFactory;

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

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

Use with caution; ensure you understand the implications.

Inherited from

UserConfig.outputOptions

---

platform?

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

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

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

Inherited from

UserConfig.plugins

---

publicDir?

optional publicDir:
  | CopyOptions
  | CopyOptionsFn;

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

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

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

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

Enable size reporting after bundling.

Default

true

Inherited from

UserConfig.report

---

shims?

optional shims: boolean;

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

Default

false

Inherited from

UserConfig.shims

---

silent?

optional silent: boolean;

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

Default

false

Deprecated

Use logLevel instead.

Inherited from

UserConfig.silent

---

skipNodeModulesBundle?

optional skipNodeModulesBundle: boolean;

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

Skip bundling node_modules.

Default

false

Inherited from

UserConfig.skipNodeModulesBundle

---

sourcemap?

optional sourcemap: Sourcemap;

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

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

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

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

Inherited from

UserConfig.tsconfig

---

unbundle?

optional unbundle: boolean;

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

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

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

Default

false

Inherited from

UserConfig.watch

---

workspace?

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

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

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

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

Default

true

Inherited from

UserConfig.write