Interface: DtsOptions
Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.14.0_rolldown@1.0.0-beta.28_typescript@5.8.3/node_modules/rolldown-plugin-dts/dist/index.d.ts:8
Properties
compilerOptions?
optional compilerOptions: CompilerOptions;
Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.14.0_rolldown@1.0.0-beta.28_typescript@5.8.3/node_modules/rolldown-plugin-dts/dist/index.d.ts:75
Override the compilerOptions
specified in tsconfig.json
.
See
https://www.typescriptlang.org/tsconfig/#compilerOptions
cwd?
optional cwd: string;
Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.14.0_rolldown@1.0.0-beta.28_typescript@5.8.3/node_modules/rolldown-plugin-dts/dist/index.d.ts:12
The directory in which the plugin will search for the tsconfig.json
file.
dtsInput?
optional dtsInput: boolean;
Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.14.0_rolldown@1.0.0-beta.28_typescript@5.8.3/node_modules/rolldown-plugin-dts/dist/index.d.ts:18
Set to true
if your entry files are .d.ts
files instead of .ts
files.
When enabled, the plugin will skip generating a .d.ts
file for the entry point.
eager?
optional eager: boolean;
Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.14.0_rolldown@1.0.0-beta.28_typescript@5.8.3/node_modules/rolldown-plugin-dts/dist/index.d.ts:105
If true
, the plugin will prepare all files listed in tsconfig.json
for tsc
or vue-tsc
.
This is especially useful when you have a single tsconfig.json
for multiple projects in a monorepo.
emitDtsOnly?
optional emitDtsOnly: boolean;
Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.14.0_rolldown@1.0.0-beta.28_typescript@5.8.3/node_modules/rolldown-plugin-dts/dist/index.d.ts:24
If true
, the plugin will emit only .d.ts
files and remove all other output chunks.
This is especially useful when generating .d.ts
files for the CommonJS format as part of a separate build step.
incremental?
optional incremental: boolean;
Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.14.0_rolldown@1.0.0-beta.28_typescript@5.8.3/node_modules/rolldown-plugin-dts/dist/index.d.ts:69
If your tsconfig.json has references
option, rolldown-plugin-dts
will use tsc -b
to build the project and all referenced projects before emitting .d.ts
files.
In such case, if this option is true
, rolldown-plugin-dts
will write down all built files into your disk, including .tsbuildinfo
and other built files. This is equivalent to running tsc -b
in your project.
Otherwise, if this option is false
, rolldown-plugin-dts
will write built files only into memory and leave a small footprint in your disk.
Enabling this option will decrease the build time by caching previous build results. This is helpful when you have a large project with multiple referenced projects.
By default, incremental
is true
if your tsconfig has incremental
or tsBuildInfoFile
enabled.
This option is only used when Options.isolatedDeclarations is false
.
isolatedDeclarations?
optional isolatedDeclarations: boolean | Omit<IsolatedDeclarationsOptions, "sourcemap">;
Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.14.0_rolldown@1.0.0-beta.28_typescript@5.8.3/node_modules/rolldown-plugin-dts/dist/index.d.ts:82
If true
, the plugin will generate .d.ts
files using Oxc, which is significantly faster than the TypeScript compiler.
This option is automatically enabled when isolatedDeclarations
in compilerOptions
is set to true
.
newContext?
optional newContext: boolean;
Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.14.0_rolldown@1.0.0-beta.28_typescript@5.8.3/node_modules/rolldown-plugin-dts/dist/index.d.ts:125
If true
, the plugin will create a new isolated context for each build, ensuring that previously generated .d.ts
code and caches are not reused.
By default, the plugin may reuse internal caches or incremental build artifacts to speed up repeated builds. Enabling this option forces a clean context, guaranteeing that all type definitions are generated from scratch.
Default: false
parallel?
optional parallel: boolean;
Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.14.0_rolldown@1.0.0-beta.28_typescript@5.8.3/node_modules/rolldown-plugin-dts/dist/index.d.ts:99
If true
, the plugin will launch a separate process for tsc
or vue-tsc
. This enables processing multiple projects in parallel.
resolve?
optional resolve: boolean | (string | RegExp)[];
Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.14.0_rolldown@1.0.0-beta.28_typescript@5.8.3/node_modules/rolldown-plugin-dts/dist/index.d.ts:90
Resolve external types used in .d.ts
files from node_modules
.
sourcemap?
optional sourcemap: boolean;
Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.14.0_rolldown@1.0.0-beta.28_typescript@5.8.3/node_modules/rolldown-plugin-dts/dist/index.d.ts:86
If true
, the plugin will generate declaration maps (.d.ts.map
) for .d.ts
files.
tsconfig?
optional tsconfig: string | boolean;
Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.14.0_rolldown@1.0.0-beta.28_typescript@5.8.3/node_modules/rolldown-plugin-dts/dist/index.d.ts:33
The path to the tsconfig.json
file.
If set to false
, the plugin will ignore any tsconfig.json
file. You can still specify compilerOptions
directly in the options.
Default
"tsconfig.json";
tsconfigRaw?
optional tsconfigRaw: Omit<TsConfigJson, "compilerOptions">;
Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.14.0_rolldown@1.0.0-beta.28_typescript@5.8.3/node_modules/rolldown-plugin-dts/dist/index.d.ts:39
Pass a raw tsconfig.json
object directly to the plugin.
See
https://www.typescriptlang.org/tsconfig
tsgo?
optional tsgo: boolean;
Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.14.0_rolldown@1.0.0-beta.28_typescript@5.8.3/node_modules/rolldown-plugin-dts/dist/index.d.ts:114
[Experimental] Enables DTS generation using tsgo
.
To use this option, make sure @typescript/native-preview
is installed as a dependency.
Note: This option is not yet recommended for production environments. tsconfigRaw
and isolatedDeclarations
options will be ignored when this option is enabled.
vue?
optional vue: boolean;
Defined in: node_modules/.pnpm/rolldown-plugin-dts@0.14.0_rolldown@1.0.0-beta.28_typescript@5.8.3/node_modules/rolldown-plugin-dts/dist/index.d.ts:94
If true
, the plugin will generate .d.ts
files using vue-tsc
.