Skip to content

Function: dts()

ts
function dts(
  packageJson: PackageJson,
  external: (string | RegExp)[],
  options?: Partial<PluginOptions>,
): Plugin;

Creates a Vite plugin for generating TypeScript declaration files with intelligent bundling.

This function configures vite-plugin-dts with sensible defaults and automatically determines which packages should be bundled into the generated declaration files. Packages listed in devDependencies are considered for bundling unless they appear in the external array.

Parameters

ParameterTypeDescription
packageJsonPackageJsonThe package.json object containing dependency information
external(string | RegExp)[]Array of module names that should remain external (not bundled)
options?Partial<PluginOptions>Optional overrides for the plugin configuration

Returns

Plugin

A configured Vite plugin instance from vite-plugin-dts

Example

typescript
import { dts } from "@nhtio/vite-plugins/dts";
import packageJson from "./package.json";

export default {
  plugins: [
    dts(packageJson, ["vue", "vue-router"], {
      strictOutput: false,
    }),
  ],
};

See

vite-plugin-dts for more details on available options.