undefined
Configure the generation of the TypeScript declaration files.
DTS generation is an optional feature, you can set dts: true
to enable bundleless DTS generation.
If you want to disable DTS generation, you can set dts: false
or do not specify the dts
option.
If you want to customize the DTS generation, you can set the dts
option to an object.
boolean
false
Whether to bundle the DTS files.
If you want to bundle DTS files, you should:
@microsoft/api-extractor
as a development dependency, which is the underlying tool used for bundling DTS files.dts.bundle
to true
.@microsoft/api-extractor only supports bundle DTS for single entry. If you want to generate bundle DTS for multiple entries, you can add extra lib configuration in lib field to split multiple entries into multiple lib configurations.
When we bundle DTS files, we should specify which third-party package types need to be bundled, refer to the Handle Third-Party Dependencies documentation for more details about externals related configurations.
string
The output directory of DTS files.
The default value follows the priority below:
dts.distPath
value in the current lib configuration.declarationDir
value in the tsconfig.json
file.boolean
false
Determines whether to generate DTS files while building the project references. This is equivalent to using the --build
flag with the tsc
command. See Project References for more details.
When this option is enabled, you must explicitly set declarationDir
or outDir
in tsconfig.json
in order to meet the build requirements.
boolean
true
Whether to abort the build process when an error occurs during DTS generation.
By default, type errors will cause the build to fail.
When abortOnError
is set to false
like below, the build will still succeed even if there are type issues in the code.
When this configuration is disabled, there is no guarantee that the type files will be generated correctly.
boolean
false
Whether to automatically set the DTS file extension based on the format option.
By default that when dts.autoExtension
is false
, the DTS file extension will be .d.ts
.
When dts.autoExtension
is set to true
, the DTS file extension will be:
.d.ts
with esm
format and .d.cts
with cjs
format when type: module
in package.json
.
.d.ts
with cjs
format and .d.mts
with esm
format when type: commonjs
or no type
field in package.json
.
It follows the same logic as lib.autoExtension, but the default value is different since the DTS file extension may cause some issues with different module resolution strategies.