OptionalbuildOptionaleagerIf 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.
OptionalemitIf true, the plugin will emit .d.ts files for .js files as well.
This is useful when you want to generate type definitions for JavaScript files with JSDoc comments.
Enabled by default when allowJs in compilerOptions is true.
This option is only used when Options.oxc is
false.
OptionalincrementalIf 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.oxc is
false.
OptionalnewIf 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.
OptionalparallelIf true, the plugin will launch a separate process for tsc or vue-tsc.
This enables processing multiple projects in parallel.
OptionaltsIf true, the plugin will generate .d.ts files using @ts-macro/tsc.
OptionalvueIf true, the plugin will generate .d.ts files using vue-tsc.
Build mode for the TypeScript compiler:
true, the plugin will usetsc -bto build the project and all referenced projects before emitting.d.tsfiles.false, the plugin will usetscto emit.d.tsfiles without building referenced projects.