Interface: DtsOptions

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:156

Configuration accepted by dts.

Extends

• GeneralOptions.TscOptions

Properties

build?

optional build?: boolean;

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:111

Uses TypeScript build mode (tsc -b) and follows project references.

Default

false

Inherited from

TscOptions.build

---

cjsDefault?

optional cjsDefault?: boolean;

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:91

Converts a single default export to export = for CommonJS consumers. This does not add support for CommonJS-style declaration input.

Default

false

Inherited from

GeneralOptions.cjsDefault

---

compilerOptions?

optional compilerOptions?: CompilerOptions;

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:69

Compiler options merged over those loaded from tsconfig.json.

Inherited from

GeneralOptions.compilerOptions

---

customLanguages?

optional customLanguages?: CustomLanguage[];

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:181

Experimental

Registers non-standard source languages such as Vue or Astro.

If a language is supported via Volar, CustomLanguage.volarTypeScript and CustomLanguage.createVolarPlugins are both required. Volar languages require tsc; tsgo does not support custom languages.

---

cwd?

optional cwd?: string;

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:44

Base directory for config discovery, glob matching, and relative paths.

Default

process.cwd()

Inherited from

GeneralOptions.cwd

---

dtsInput?

optional dtsInput?: boolean;

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:50

Treats entry files as existing declarations instead of source files.

Default

false

Inherited from

GeneralOptions.dtsInput

---

eager?

optional eager?: boolean;

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:141

Loads every file listed by tsconfig.json into the TypeScript program.

Useful when one config covers multiple packages or entry points.

Default

false

Inherited from

TscOptions.eager

---

emitDtsOnly?

optional emitDtsOnly?: boolean;

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:56

Removes non-declaration chunks from the output.

Default

false

Inherited from

GeneralOptions.emitDtsOnly

---

emitJs?

optional emitJs?: boolean;

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:153

Generates declarations for JavaScript files with JSDoc types.

Default

Enabled when allowJs or checkJs is set.

Inherited from

TscOptions.emitJs

---

entry?

optional entry?: string | string[];

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:38

Glob pattern(s) that select source files for declaration generation.

Patterns are relative to cwd and may be negated with !. Matching files are emitted even when they are not Rolldown entry points.

Example

entry: ['src/*.ts', '!src/internal/**']

Inherited from

GeneralOptions.entry

---

generator?

optional generator?: "tsc" | "oxc" | "tsgo";

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:26

The generator used to produce declaration files.

• 'tsc' supports the full TypeScript type system.
• 'oxc' is faster but requires code compatible with isolatedDeclarations.
• 'tsgo' uses the experimental TypeScript Go compiler.

When omitted, the plugin selects 'oxc' for isolatedDeclarations, 'tsgo' for TypeScript 7, and 'tsc' otherwise. Volar-based custom languages require 'tsc'.

Default

Inferred from the TypeScript configuration and installed compiler.

Inherited from

GeneralOptions.generator

---

incremental?

optional incremental?: boolean;

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:118

Persists build-mode outputs, including .tsbuildinfo, to disk for reuse. When disabled, build outputs stay in memory.

Default

Enabled when the config sets incremental or tsBuildInfoFile.

Inherited from

TscOptions.incremental

---

logger?

optional logger?: Logger;

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:103

Logger used for plugin messages.

Default

console

Inherited from

GeneralOptions.logger

---

newContext?

optional newContext?: boolean;

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:147

Uses an isolated TypeScript cache instead of the shared global context.

Default

false

Inherited from

TscOptions.newContext

---

oxc?

optional oxc?: Omit<IsolatedDeclarationsOptions, "sourcemap">;

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:163

Options for the oxc generator.

The top-level sourcemap option controls declaration maps.

---

parallel?

optional parallel?: boolean;

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:133

Runs tsc or vue-tsc in a separate process.

Default

false

Inherited from

TscOptions.parallel

---

resolver?

optional resolver?: "tsc" | "oxc";

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:84

Resolver used for declaration imports, including packages in node_modules.

Use 'tsc' when a project depends on TypeScript-specific resolution behavior; otherwise 'oxc' is faster.

Default

'oxc'

Inherited from

GeneralOptions.resolver

---

sideEffects?

optional sideEffects?: boolean;

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:97

Marks declaration modules as having side effects during tree-shaking.

Default

false

Inherited from

GeneralOptions.sideEffects

---

sourcemap?

optional sourcemap?: boolean;

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:75

Emits declaration maps (.d.ts.map).

Default

The value of compilerOptions.declarationMap.

Inherited from

GeneralOptions.sourcemap

---

tsconfig?

optional tsconfig?: string | boolean;

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:63

A tsconfig.json path, resolved relative to cwd.

When omitted or true, the nearest config is discovered from cwd. Set to false to disable config loading.

Inherited from

GeneralOptions.tsconfig

---

tsconfigRaw?

optional tsconfigRaw?: Omit<TsConfigJson, "compilerOptions">;

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:65

Raw tsconfig.json values merged over the loaded config.

Inherited from

GeneralOptions.tsconfigRaw

---

tsgo?

optional tsgo?: TsgoOptions;

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:170

[Experimental] Options for the tsgo generator.

Used when generator is 'tsgo' or TypeScript 7 is detected.

---

vue?

optional vue?: boolean;

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.28.0_@volar+typescript@2.4.28_typescript@6.0.3__rolldown@1.2.3_ty_8e5c8c396fcad311132dad5b7f2c9dab/node_modules/rolldown-plugin-dts/dist/index.d.mts:127

Registers the built-in Vue language integration using vue-tsc.

This is a shortcut for a preconfigured Options.customLanguages entry and requires the tsc generator.

Default

false

Inherited from

TscOptions.vue