Skip to content

tristan-f-r/dts_minify

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

24 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

dts-minify

npm version CI deno doc

Minifies TypeScript declaration files (.d.ts files).

Strips:

  • Non-essential whitespace and newlines.
  • Comments, but keeps triple-slash directives.

Use Case

This library is useful for minifying declaration files that won't be read by humans.

Example

import { createMinifier } from "dts-minify";
import * as ts from "typescript";

// setup (provide a TS Compiler API object)
const minifier = createMinifier(ts);

// minify
const inputText = `declare class MyClass {
    /**
     * Some description.
     */
    doSomething(value: number): number;
}`;
const minifiedText = minifier.minify(inputText);

console.log(minifiedText);

Outputs:

declare class MyClass{doSomething(value:number):number;}

Options

keepJsDocs

When true, it won't remove the JS docs.

const minifiedText = minifier.minify(inputText, {
  keepJsDocs: true, // false by default
});

Outputs:

declare class MyClass{/**
 * Some description.
 */doSomething(value:number):number;}

About

Minifier for TypeScript declaration files (.d.ts)

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 95.3%
  • Dockerfile 4.7%