dts

Interfaces

PluginOptions

Defined in: node_modules/.pnpm/unplugin-dts@1.1.2_@voidzero-dev+vite-plus-core@1.3.0_@types+node@26.6.5_@volar+typescr_e5820e6a769e575e80f2b9c7e6b951a8/node_modules/unplugin-dts/dist/shared/unplugin-dts.C99DotQ6.d.mts:436

插件配置；outDirs 未指定 moduleFormat 时保留 TypeScript 原始声明后缀。

Extends

Omit<Partial<CreateRuntimeOptions>, "entries" | "libName" | "indexName" | "logger">
Omit<EmitOptions, "logPrefix">

Properties

afterBootstrap?

optional afterBootstrap?: (runtime) => MaybePromise<void>

Hook called after the runtime is created.

Parameters

runtime

Runtime

Returns

MaybePromise<void>

Default

() => {}

afterBuild?

optional afterBuild?: (emittedFiles) => MaybePromise<void>

Hook called after all declaration files are written.

It will be received a map (path -> content) that records those emitted files.

Parameters

emittedFiles

Map<string, string>

Returns

MaybePromise<void>

Default

() => {}

afterDiagnostic?

optional afterDiagnostic?: (diagnostics) => MaybePromise<void>

Hook called after diagnostic is emitted.

According to the diagnostics.length, you can judge whether there is any type error.

Parameters

diagnostics

readonly Diagnostic[]

Returns

MaybePromise<void>

Default

() => {}

afterRollup?

optional afterRollup?: (result) => MaybePromise<void>

Hook called after rolling up declaration files.

Parameters

result

ExtractorResult

Returns

MaybePromise<void>

Default

() => {}

Inherited from

Omit.afterRollup

aliases?

optional aliases?: AliasOptions

Inherited from

Omit.aliases

aliasesExclude?

optional aliasesExclude?: (string | RegExp)[]

Set which paths should be excluded when transforming aliases.

Default

[]

Inherited from

Omit.aliasesExclude

beforeWriteFile?

optional beforeWriteFile?: (filePath, content) => MaybePromise<false | void | { content?: string; filePath?: string; }>

Hook called prior to writing each declaration file.

This allows you to transform the path or content.

The file will be skipped when the return value false or Promise<false>.

Parameters

filePath

string

content

string

Returns

MaybePromise<false | void | { content?: string; filePath?: string; }>

Default

() => {}

Inherited from

Omit.beforeWriteFile

bundleTypes?

optional bundleTypes?: boolean | { bundledPackages?: string[]; configPath?: string; extractorConfig?: BundleConfig; invokeOptions?: ExtractorInvokeOptions; }

Rollup type declaration files after emitting them.

Union Members

boolean

Type Literal

{ bundledPackages?: string[]; configPath?: string; extractorConfig?: BundleConfig; invokeOptions?: ExtractorInvokeOptions; }

bundledPackages?

optional bundledPackages?: string[]

Bundled packages for @microsoft/api-extractor.

Default

[]

See

https://api-extractor.com/pages/configs/api-extractor_json/#bundledpackages

configPath?

optional configPath?: string

Specify a real api-extractor config file path.

When invoking, the configuration will be merged in the order: internal config, file config, extractorConfig.

Default

'./api-extractor.json'

extractorConfig?

optional extractorConfig?: BundleConfig

Override the config of @microsoft/api-extractor.

Default

{}

See

https://api-extractor.com/pages/setup/configure_api_report/

invokeOptions?

optional invokeOptions?: ExtractorInvokeOptions

Override the invoke options of @microsoft/api-extractor.

Default

{}

See

https://api-extractor.com/pages/setup/invoking/#invoking-from-a-build-script

Default

false

Inherited from

Omit.bundleTypes

cleanVueFileName?

optional cleanVueFileName?: boolean

Whether to transform file names ending in '.vue.d.ts' to '.d.ts'.

If there is a duplicate name after transform, it will fall back to the original name.

Default

false

Inherited from

Omit.cleanVueFileName

clearPureImport?

optional clearPureImport?: boolean

Whether to remove import 'xxx'.

Default

true

Inherited from

Omit.clearPureImport

compilerOptions?

optional compilerOptions?: CompilerOptions | null

Override compilerOptions.

Default

null

Inherited from

Omit.compilerOptions

copyDtsFiles?

optional copyDtsFiles?: boolean

Whether to copy .d.ts source files to outDir.

Default

false

Inherited from

Omit.copyDtsFiles

declarationOnly?

optional declarationOnly?: boolean

Whether to emit declaration files only.

When true, all the original outputs will be force removed, except esbuild.

Default

false

entryRoot?

optional entryRoot?: string

Override root path of entry files (useful in monorepos).

The output path of each file will be calculated based on the value provided.

The default is the smallest public path for all source files.

Inherited from

Omit.entryRoot

exclude?

optional exclude?: string | string[]

Override exclude glob.

Defaults to exclude property of tsconfig.json or 'node_modules/**' if not supplied.

Inherited from

Omit.exclude

include?

optional include?: string | string[]

Override include glob (relative to root).

Defaults to include property of tsconfig.json (relative to tsconfig.json located).

Inherited from

Omit.include

insertTypesEntry?

optional insertTypesEntry?: boolean

Whether to generate types entry file(s).

When true, uses package.json types property if it exists or ${outDir}/index.d.ts.

Value is forced to true when bundleTypes is enabled.

Default

false

Inherited from

Omit.insertTypesEntry

outDirs?

optional outDirs?: OutDirsOption

Output directory for declaration files.

Can be a string, array of strings, OutDirConfig object, or array of OutDirConfig objects. Supports mixed arrays containing both strings and OutDirConfig objects.

Examples

// Simple string
outDirs: 'dist'

// String array (backward compatible)
outDirs: ['dist', 'types']

// Object configuration
outDirs: { dir: 'dist', moduleFormat: 'esm' }

// Mixed array
outDirs: [
  'dist',  // default .d.ts
  { dir: 'dist-cjs', moduleFormat: 'cjs' },  // .d.cts
  { dir: 'dist-esm', moduleFormat: 'esm' }   // .d.mts
]

The default is to use the out directory provided by the scaffold.

Inherited from

Omit.outDirs

pathsToAliases?

optional pathsToAliases?: boolean

Parsing paths of tsconfig.json to aliases.

Note that these aliases only use for declaration files.

Default

true

Remarks

Only use first replacement of each path.

Inherited from

Omit.pathsToAliases

processor?

optional processor?: "vue" | "ts"

Specify which (program) processor you prefer.

When not specified, the plugin will automatically detect .vue files and use 'vue' processor if needed.

Default

'ts'

Inherited from

Omit.processor

resolvers?

optional resolvers?: Resolver[]

Specify custom resolvers.

Default

[]

Inherited from

Omit.resolvers

root?

optional root?: string

Specify root directory.

The default is to use the root provided by the scaffold; if none is provided, it defaults to process.cwd().

Inherited from

Omit.root

staticImport?

optional staticImport?: boolean

Whether to transform dynamic imports to static (eg import('vue').DefineComponent to import { DefineComponent } from 'vue').

Value is forced to true when bundleTypes is enabled.

Default

false

Inherited from

Omit.staticImport

strictOutput?

optional strictOutput?: boolean

Restrict declaration files output to outDir.

If true, generated declaration files outside outDir will be ignored.

Default

true

Inherited from

Omit.strictOutput

tsconfigPath?

optional tsconfigPath?: string

Specify tsconfig.json path.

Plugin resolves include and exclude globs from tsconfig.json.

If not specified, plugin will find config file from root.

Inherited from

Omit.tsconfigPath

Functions

default()

default(options?): Plugin<{ options: PluginOptions; }>

Defined in: packages/vite/src/dts.ts:16

A wrapper around unplugin-dts that also exposes the options so that other plugins can use the same TS config without having to copy paste settings

Parameters

options?

PluginOptions = {}

Returns

Plugin<{ options: PluginOptions; }>

getDTSPlugin()

getDTSPlugin(config): Plugin<{ options: PluginOptions; }>[]

Defined in: packages/vite/src/dts.ts:28

Parameters

config

ResolvedConfig

Returns

Plugin<{ options: PluginOptions; }>[]

getDTSPluginOptions()

getDTSPluginOptions(config): PluginOptions

Defined in: packages/vite/src/dts.ts:32

Parameters

config

ResolvedConfig

Returns

PluginOptions

dts ​

Interfaces ​

PluginOptions ​

Extends ​

Properties ​

afterBootstrap? ​

Parameters ​

runtime ​

Returns ​

Default ​

afterBuild? ​

Parameters ​

emittedFiles ​

Returns ​

Default ​

afterDiagnostic? ​

Parameters ​

diagnostics ​

Returns ​

Default ​

afterRollup? ​

Parameters ​

result ​

Returns ​

Default ​

Inherited from ​

aliases? ​

Inherited from ​

aliasesExclude? ​

Default ​

Inherited from ​

beforeWriteFile? ​

Parameters ​

filePath ​

content ​

Returns ​

Default ​

Inherited from ​

bundleTypes? ​

Union Members ​

Type Literal ​

bundledPackages? ​

Default ​

See ​

configPath? ​

Default ​

extractorConfig? ​

Default ​

See ​

invokeOptions? ​

Default ​

See ​

Default ​

Inherited from ​

cleanVueFileName? ​

Default ​

Inherited from ​

clearPureImport? ​

Default ​

Inherited from ​

compilerOptions? ​

Default ​

Inherited from ​

copyDtsFiles? ​

Default ​

Inherited from ​

declarationOnly? ​

Default ​

entryRoot? ​

Inherited from ​

exclude? ​

Inherited from ​

include? ​

Inherited from ​

insertTypesEntry? ​

Default ​

Inherited from ​

outDirs? ​

Examples ​

Inherited from ​

dts

Interfaces

PluginOptions

Extends

Properties

afterBootstrap?

Parameters

runtime

Returns

Default

afterBuild?

Parameters

emittedFiles

Returns

Default

afterDiagnostic?

Parameters

diagnostics

Returns

Default

afterRollup?

Parameters

result

Returns

Default

Inherited from

aliases?

Inherited from

aliasesExclude?

Default

Inherited from

beforeWriteFile?

Parameters

filePath

content

Returns

Default

Inherited from

bundleTypes?

Union Members

Type Literal

bundledPackages?

Default

See

configPath?

Default

extractorConfig?

Default

See

invokeOptions?

Default

See

Default

Inherited from

cleanVueFileName?

Default

Inherited from

clearPureImport?

Default

Inherited from

compilerOptions?

Default

Inherited from

copyDtsFiles?

Default

Inherited from

declarationOnly?

Default

entryRoot?

Inherited from

exclude?

Inherited from

include?

Inherited from

insertTypesEntry?

Default

Inherited from

outDirs?

Examples

Inherited from