@types/html-minifier-terser

What is @types/html-minifier-terser?

The @types/html-minifier-terser package provides TypeScript type definitions for the html-minifier-terser package, which is a tool to minify HTML files. These type definitions allow TypeScript developers to use html-minifier-terser in their projects with the benefits of TypeScript's static type checking. The main functionalities include minifying HTML, removing comments, collapsing whitespace, and more, all while preserving the validity of the HTML.

What are @types/html-minifier-terser's main functionalities?

Minifying HTML

This feature allows you to minify HTML content by removing unnecessary spaces, comments, and other unneeded parts to reduce the size of the files. The code sample demonstrates how to remove attribute quotes from a simple HTML string.

import { minify } from 'html-minifier-terser';

const result = minify('<p title="blah" id="moo">foo</p>', {
  removeAttributeQuotes: true
});
console.log(result);

Collapsing Whitespace

This feature collapses unnecessary whitespace within the HTML to further reduce the file size without affecting the structure. The code sample shows how to collapse whitespace around and within HTML tags.

import { minify } from 'html-minifier-terser';

const result = minify('   <div>    <p>Example</p>    </div>   ', {
  collapseWhitespace: true
});
console.log(result);

Removing Comments

This functionality allows the removal of HTML comments from the file, which can be particularly useful for removing development notes and reducing file size. The code sample demonstrates removing a comment from an HTML string.

import { minify } from 'html-minifier-terser';

const result = minify('<!-- This is a comment --> <div>Content</div>', {
  removeComments: true
});
console.log(result);

Other packages similar to @types/html-minifier-terser

gulp-htmlmin

gulp-htmlmin is a gulp plugin that minifies HTML. It wraps around html-minifier and provides a similar set of functionalities but is designed to be used in the gulp streaming build system. Compared to @types/html-minifier-terser, gulp-htmlmin is more specific to users of gulp.

webpack-html-plugin

webpack-html-plugin simplifies the creation of HTML files to serve your webpack bundles. While not a direct alternative for minifying HTML, it can be configured to use html-minifier-terser as part of its process, offering a more integrated approach in webpack-based projects.

README

Installation

npm install --save @types/html-minifier-terser

Summary

This package contains type definitions for html-minifier-terser (https://github.com/terser/html-minifier-terser#readme).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/html-minifier-terser.

Additional Details

• Last updated: Wed, 18 Oct 2023 01:17:35 GMT
• Dependencies: none

Credits

These definitions were written by Piotr Błażejewicz.