Interface: DtsOptions

Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.29.0-beta.2_@volar+typescript@2.4.28_typescript@6.0.3__@vue+langu_c05ee0deaa818ec34770b8c8607670cc/node_modules/rolldown-plugin-dts/dist/index.d.mts:35

Properties

cjsDefault?

cjsDefault?: boolean;

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

Default

false

compilerOptions?

compilerOptions?: CompilerOptions;

Compiler options merged over those loaded from tsconfig.json. In the plugin's current tsgo implementation, these affect plugin behavior but do not override the program's compiler options. Set those options in the config file instead.

customLanguages?

customLanguages?: CustomLanguage[];

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. Non-Volar languages can use tsgo together with TsgoOptions.vfs `tsgo.vfs`.

cwd?

cwd?: string;

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

Default

process.cwd()

dtsInput?

dtsInput?: boolean;

Treats entry files as existing declarations instead of source files.

Default

false

emitDtsOnly?

emitDtsOnly?: boolean;

Removes non-declaration chunks from the output.

Default

false

emitJs?

emitJs?: boolean;

Generates declarations for JavaScript files with JSDoc types.

Default

Enabled when allowJs or checkJs is set.

entry?

entry?: string | string[];

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/**']

generator?

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

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 API.
A custom Generator implementation can be provided directly.

When omitted, the plugin selects 'oxc' for isolatedDeclarations, 'tsgo' when TypeScript exposes the declaration emit API, and 'tsc' otherwise. Volar-based custom languages require 'tsc'.

Default

Inferred from the TypeScript configuration and installed compiler.

logger?

logger?: Logger;

Logger used for plugin messages.

Default

console

oxc?

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

Options for the oxc generator.

The top-level sourcemap option controls declaration maps.

resolver?

resolver?: "tsc" | "oxc";

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'

sideEffects?

sideEffects?: boolean;

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

Default

false

sourcemap?

sourcemap?: boolean;

Emits declaration maps (.d.ts.map). With tsgo, source mappings also require compilerOptions.declarationMap to be enabled in the on-disk config; sourcemap: true alone is insufficient.

Default

The value of compilerOptions.declarationMap.

tsc?

tsc?: TscOptions;

Options for the built-in tsc generator.

tsconfig?

tsconfig?: string | boolean;

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. The tsgo generator requires a config file.

tsconfigRaw?

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

Raw tsconfig.json values merged over the loaded config. The plugin's current tsgo implementation does not apply these overrides to the TypeScript program.

tsgo?

tsgo?: TsgoOptions;

[Experimental] Options for the TypeScript Go generator.

Interface: DtsOptions ​

Properties ​

cjsDefault? ​

Default ​

compilerOptions? ​

customLanguages? ​

cwd? ​

Default ​

dtsInput? ​

Default ​

emitDtsOnly? ​

Default ​

emitJs? ​

Default ​

entry? ​

Example ​

generator? ​

Default ​

logger? ​

Default ​

oxc? ​

resolver? ​

Default ​

sideEffects? ​

Default ​

sourcemap? ​

Default ​

tsc? ​

tsconfig? ​

tsconfigRaw? ​

tsgo? ​

Interface: DtsOptions

Properties

cjsDefault?

Default

compilerOptions?

customLanguages?

cwd?

Default

dtsInput?

Default

emitDtsOnly?

Default

emitJs?

Default

entry?

Example

generator?

Default

logger?

Default

oxc?

resolver?

Default

sideEffects?

Default

sourcemap?

Default

tsc?

tsconfig?

tsconfigRaw?

tsgo?