dts-minify

library0.3.3jsnpmunverified

Minifier for TypeScript declaration files (.d.ts). Strips non-essential whitespace, newlines, and comments (preserving triple-slash directives) to reduce file size. Current stable version is 0.3.3. Released on both npm and JSR, maintained by dsherret. Designed for projects where .d.ts files are not read by humans, such as bundling for libraries. Differentiates by being lightweight and focused solely on .d.ts minification, unlike general-purpose minifiers.

devops

npm install dts-minify

github ↗package ↗homepage ↗

INSTALL

IMPORT

SIG · DTS-MINIFY

dts-minify

devopsjavascriptv0.3.3

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

createMinifier

✓ import { createMinifier } from 'dts-minify'

✗ import createMinifier from 'dts-minify'

Default export does not exist; must use named import.

createMinifier

✓ const { createMinifier } = require('dts-minify')

CommonJS require is supported; ESM is the default in Node, but CJS works too.

MinifierOptions

✓ import type { MinifierOptions } from 'dts-minify'

✗ import { MinifierOptions } from 'dts-minify'

Option type is not a runtime value; use type import to avoid bundling issues.

Shows how to import, create a minifier, and minify a .d.ts content with and without keeping JSDoc comments.

import { createMinifier } from 'dts-minify'; import * as ts from 'typescript'; const minifier = createMinifier(ts); const inputText = `declare class MyClass { /** * Some description. */ doSomething(value: number): number; }`; const minifiedText = minifier.minify(inputText); console.log(minifiedText); // Output: declare class MyClass{doSomething(value:number):number;} // With options const minifiedWithJsDocs = minifier.minify(inputText, { keepJsDocs: true }); console.log(minifiedWithJsDocs); // Retains JSDoc comments

Debug

Known issues

gotchaRequires passing TypeScript Compiler API object (ts) to createMinifier(). Forgetting to import typescript will cause runtime error.

fix

Ensure 'typescript' is installed as a dependency and pass ts module to createMinifier.

affects: >=0

breakingInput must be valid TypeScript declaration syntax; invalid input throws errors.

fix

Validate your .d.ts file with a TypeScript parser before calling minifier.minify().

affects: >=0

gotchaTriple-slash directives are preserved, but other comments are removed by default. This can affect type resolution if directives are not recognized.

fix

If you need to keep other comments (e.g., @deprecated), set keepJsDocs: true or handle manually.

affects: >=0

Errors

Common errors & fixes

TypeError: createMinifier is not a function

Default import used instead of named import.

fix

Change to: import { createMinifier } from 'dts-minify'

Error: Cannot find module 'typescript'

Missing dependency 'typescript'.

fix

Run: npm install typescript

TypeError: minifier.minify is not a function

createMinifier was not called correctly (e.g., passed null or incorrect object).

fix

Ensure you call createMinifier(ts) with the full 'typescript' module object.

Upgrade

Version history

0.3.3latest on npm

Audit

Dependencies

typescriptrequiredRequired to create the minifier via createMinifier(ts) – provides the TypeScript Compiler API for parsing and emitting declarations.

Agent activity

2 hits · last 30 days

node

Resources

githubhttps://github.com/dsherret/dts_minify ↗

packagedts-minify ↗

homepagehttps://github.com/dsherret/dts_minify#readme ↗