Merge pull request #283 from cueaz/fix-removecomments

fix: add missing argument in typescript definition of removeComments
posthtml · May 5, 2024 · 249b2a4 · 249b2a4
2 parents 151da26 + ecc80a9
commit 249b2a4
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/docs/docs/050-modules.md b/docs/docs/050-modules.md
@@ -414,8 +414,8 @@ Source:
 
 ```js
 {
-    removeComments: (comments) => {
-        if (comments.includes('noindex')) return true;
+    removeComments: (comment) => {
+        if (comment.includes('noindex')) return true;
         return false;
     }
 }

diff --git a/index.d.ts b/index.d.ts
@@ -22,7 +22,7 @@ export interface HtmlnanoOptions {
   minifySvg?: SvgoOptimizeOptions | boolean;
   normalizeAttributeValues?: boolean;
   removeAttributeQuotes?: boolean;
-  removeComments?: boolean | "safe" | "all" | RegExp | (() => boolean);
+  removeComments?: boolean | "safe" | "all" | RegExp | ((comment: string) => boolean);
   removeEmptyAttributes?: boolean;
   removeRedundantAttributes?: boolean;
   removeOptionalTags?: boolean;

diff --git a/test/modules/removeComments.mjs b/test/modules/removeComments.mjs
@@ -122,8 +122,8 @@ describe('removeComments', () => {
                 '<!--noindex-->this text will not be indexed<!--/noindex-->Lorem ipsum dolor sit amet<!--more-->Lorem ipsum dolor sit amet',
                 'this text will not be indexedLorem ipsum dolor sit amet<!--more-->Lorem ipsum dolor sit amet',
                 {
-                    removeComments: (comments) => {
-                        if (comments.includes('noindex')) return true;
+                    removeComments: (comment) => {
+                        if (comment.includes('noindex')) return true;
                         return false;
                     },
                 }