Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Type Declarations #1006

Merged
merged 10 commits into from
Oct 18, 2024
Merged

Add Type Declarations #1006

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
7b934bf
Add TypeScript config.
reduckted Oct 9, 2024
b10b1eb
Rename `.js` files to `.ts`.
reduckted Oct 9, 2024
bab807e
Disabled some lint rules.
reduckted Oct 16, 2024
399ebee
Configure rollup to process TypeScript.
reduckted Oct 9, 2024
a476377
Defines types for the config.
reduckted Oct 11, 2024
6c15002
Added type annotations to utils.
reduckted Oct 9, 2024
702b3b2
Added type annotations to the public interface so that type declarati…
reduckted Oct 12, 2024
6e60632
Updated Rollup dependencies and installed `rollup-plugin-dts`.
reduckted Oct 17, 2024
faf296d
Generated type declaration files.
reduckted Oct 17, 2024
f487c8e
Updated `dist` files.
reduckted Oct 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 0 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,10 +57,6 @@ Note that by default, we permit HTML, SVG **and** MathML. If you only need HTML,
const clean = DOMPurify.sanitize(dirty, { USE_PROFILES: { html: true } });
```

### Where are the TypeScript type definitions?

They can be found here: [@types/dompurify](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/dompurify)

### Is there any foot-gun potential?

Well, please note, if you _first_ sanitize HTML and then modify it _afterwards_, you might easily **void the effects of sanitization**. If you feed the sanitized markup to another library _after_ sanitization, please be certain that the library doesn't mess around with the HTML on its own.
Expand Down
Loading
Loading