marmotte

Appearance

marmotte / vite/dts

vite/dts ​

Interfaces ​

PluginOptions ​

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:400

Extends ​

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

Properties ​

afterBootstrap? ​

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

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:414

Hook called after the runtime is created.

Parameters ​
runtime ​

Runtime

Returns ​

MaybePromise<void>

Default ​
ts
() => {}
afterBuild? ​

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

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:430

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 ​
ts
() => {}
afterDiagnostic? ​

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

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:422

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 ​
ts
() => {}
afterRollup? ​

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

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:321

Hook called after rolling up declaration files.

Parameters ​
result ​

ExtractorResult

Returns ​

MaybePromise<void>

Default ​
ts
() => {}
Inherited from ​

Omit.afterRollup

aliases? ​

optional aliases?: AliasOptions

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:206

Inherited from ​

Omit.aliases

aliasesExclude? ​

optional aliasesExclude?: (string | RegExp)[]

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:212

Set which paths should be excluded when transforming aliases.

Default ​
ts
[]
Inherited from ​

Omit.aliasesExclude

beforeWriteFile? ​

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

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:312

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 ​
ts
() => {}
Inherited from ​

Omit.beforeWriteFile

bundleTypes? ​

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

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:272

Rollup type declaration files after emitting them.

Powered by @microsoft/api-extractor - time-intensive operation.

Union Members ​

boolean

Type Literal ​

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

bundledPackages? ​

optional bundledPackages?: string[]

Bundled packages for @microsoft/api-extractor.

Default ​
ts
[]
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 ​
ts
'./api-extractor.json'
extractorConfig? ​

optional extractorConfig?: BundleConfig

Override the config of @microsoft/api-extractor.

Default ​
ts
{}
See ​

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

invokeOptions? ​

optional invokeOptions?: ExtractorInvokeOptions

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

Default ​
ts
{}
See ​

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

Default ​
ts
false
Inherited from ​

Omit.bundleTypes

cleanVueFileName? ​

optional cleanVueFileName?: boolean

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:240

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 ​
ts
false
Inherited from ​

Omit.cleanVueFileName

clearPureImport? ​

optional clearPureImport?: boolean

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:254

Whether to remove import 'xxx'.

Default ​
ts
true
Inherited from ​

Omit.clearPureImport

compilerOptions? ​

optional compilerOptions?: CompilerOptions | null

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:178

Override compilerOptions.

Default ​
ts
null
Inherited from ​

Omit.compilerOptions

copyDtsFiles? ​

optional copyDtsFiles?: boolean

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:232

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

Default ​
ts
false
Inherited from ​

Omit.copyDtsFiles

declarationOnly? ​

optional declarationOnly?: boolean

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:408

Whether to emit declaration files only.

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

Default ​
ts
false
entryRoot? ​

optional entryRoot?: string

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:164

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[]

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:199

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[]

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:193

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

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:264

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 ​
ts
false
Inherited from ​

Omit.insertTypesEntry

outDirs? ​

optional outDirs?: OutDirsOption

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:156

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 ​
ts
// Simple string
outDirs: 'dist'
ts
// String array (backward compatible)
outDirs: ['dist', 'types']
ts
// Object configuration
outDirs: { dir: 'dist', moduleFormat: 'esm' }
ts
// 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

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:187

Parsing paths of tsconfig.json to aliases.

Note that these aliases only use for declaration files.

Default ​
ts
true
Remarks ​

Only use first replacement of each path.

Inherited from ​

Omit.pathsToAliases

processor? ​

optional processor?: "vue" | "ts"

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:121

Specify which (program) processor you prefer.

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

Default ​
ts
'ts'
Inherited from ​

Omit.processor

resolvers? ​

optional resolvers?: Resolver[]

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:205

Specify custom resolvers.

Default ​
ts
[]
Inherited from ​

Omit.resolvers

root? ​

optional root?: string

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:127

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

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:248

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 ​
ts
false
Inherited from ​

Omit.staticImport

strictOutput? ​

optional strictOutput?: boolean

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:226

Restrict declaration files output to outDir.

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

Default ​
ts
true
Inherited from ​

Omit.strictOutput

tsconfigPath? ​

optional tsconfigPath?: string

Defined in: node_modules/unplugin-dts/dist/shared/unplugin-dts.PNIpryzr.d.mts:172

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: src/vite/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: src/vite/dts.ts:28

Parameters ​

config ​

ResolvedConfig

Returns ​

Plugin<{ options: PluginOptions; }>[]

getDTSPluginOptions() ​

getDTSPluginOptions(config): PluginOptions

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

Parameters ​

config ​

ResolvedConfig

Returns ​

PluginOptions