Merge pull request #655 from dylanarmstrong/doc/readme-typescript-ver…

…sion doc: add supported version for typescript
apostrophecms · Feb 23, 2024 · d2925db · d2925db
2 parents 4a7d7dd + dade120
commit d2925db
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,9 @@
 # Changelog
 
+## UNRELEASED
+
+- Documentation update regarding minimum supported TypeScript version.
+
 ## 2.12.1 (2024-02-22)
 
 - Do not parse sourcemaps in `post-css`. This fixes a vulnerability in which information about the existence or non-existence of files on a server could be disclosed via properly crafted HTML input when the `style` attribute is allowed by the configuration. Thanks to the [Snyk Security team](https://snyk.io/) for the disclosure and to [Dylan Armstrong](https://dylan.is/) for the fix.

diff --git a/README.md b/README.md
@@ -40,6 +40,8 @@ If `esModuleInterop=true` is not set in your `tsconfig.json` file, you have to i
 import * as sanitizeHtml from 'sanitize-html';
 ```
 
+When using TypeScript, there is a minimum supported version of >=4.5 because of a dependency on the `htmlparser2` types.
+
 Any questions or problems while using `@types/sanitize-html` should be directed to its maintainers as directed by that project's contribution guidelines.
 
 ## How to use