Interface: Options

Defined in: options.ts:50

Options for tsdown.

Properties

alias?

optional alias: Record<string, string>

Defined in: options.ts:60

---

clean?

optional clean: boolean | string[]

Defined in: options.ts:83

Clean directories before build.

Default to output directory.

---

config?

optional config: string | boolean

Defined in: options.ts:142

Config file path

---

copy?

optional copy: CopyOptions | CopyOptionsFn

Defined in: options.ts:216

Copy files to another directory.

Example

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

---

define?

optional define: Record<string, string>

Defined in: options.ts:110

---

dts?

optional dts: boolean | Options

Defined in: options.ts:169

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: options.ts:52

---

env?

optional env: Record<string, any>

Defined in: options.ts:199

Compile-time env variables.

Example

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

---

external?

optional external: ExternalOption

Defined in: options.ts:53

---

fixedExtension?

optional fixedExtension: boolean

Defined in: options.ts:120

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

---

format?

optional format: Format | Format[]

Defined in: options.ts:73

Default

'es'

---

fromVite?

optional fromVite: boolean | "vitest"

Defined in: options.ts:159

Reuse config from Vite or Vitest (experimental)

Default

false

---

globalName?

optional globalName: string

Defined in: options.ts:74

---

hooks?

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

Defined in: options.ts:218

---

inputOptions?

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

Defined in: options.ts:64

---

minify?

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

Defined in: options.ts:85

Default

false

---

noExternal?

optional noExternal: Arrayable<string | RegExp> | (id, importer) => undefined | null | boolean | void

Defined in: options.ts:54

---

onSuccess?

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

Defined in: options.ts:148

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

---

outDir?

optional outDir: string

Defined in: options.ts:76

Default

'dist'

---

outExtensions?

optional outExtensions: OutExtensionFactory

Defined in: options.ts:125

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

---

outputOptions?

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

Defined in: options.ts:127

---

platform?

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

Defined in: options.ts:63

Default

'node'

---

plugins?

optional plugins: RolldownPluginOption<any>

Defined in: options.ts:136

---

publicDir?

optional publicDir: CopyOptions | CopyOptionsFn

Defined in: options.ts:204

Deprecated

Alias for copy, will be removed in the future.

---

publint?

optional publint: boolean | Options

Defined in: options.ts:181

Run publint after bundling. Requires publint to be installed.

---

removeNodeProtocol?

optional removeNodeProtocol: boolean

Defined in: options.ts:231

If enabled, strips the node: protocol prefix from import source.

Default

false

Example

// With removeNodeProtocol enabled:
import('node:fs'); // becomes import('fs')

---

report?

optional report: boolean | ReportOptions

Defined in: options.ts:187

Enable size reporting after bundling.

Default

true

---

shims?

optional shims: boolean

Defined in: options.ts:112

Default

false

---

silent?

optional silent: boolean

Defined in: options.ts:138

---

skipNodeModulesBundle?

optional skipNodeModulesBundle: boolean

Defined in: options.ts:153

Skip bundling node_modules.

---

sourcemap?

optional sourcemap: Sourcemap

Defined in: options.ts:77

---

target?

optional target: string | string[]

Defined in: options.ts:108

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/guide/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: options.ts:135

Default

true

---

tsconfig?

optional tsconfig: string | boolean

Defined in: options.ts:61

---

unused?

optional unused: boolean | Options

Defined in: options.ts:175

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

---

watch?

optional watch: string | boolean | string[]

Defined in: options.ts:143