Merge pull request #1028 from MiniDigger/optional-dompurify-argument-…

…type fix: mark createDOMPurify param as optional
cure53 · Nov 19, 2024 · 8e1c70a · 8e1c70a
2 parents f93acff + 071771c
commit 8e1c70a
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/dist/purify.cjs.d.ts b/dist/purify.cjs.d.ts
@@ -206,9 +206,9 @@ declare const _default: DOMPurify;
 
 interface DOMPurify {
     /**
-     * Creates a DOMPurify instance using the given window-like object.
+     * Creates a DOMPurify instance using the given window-like object. Defaults to `window`.
      */
-    (root: WindowLike): DOMPurify;
+    (root?: WindowLike): DOMPurify;
     /**
      * Version label, exposed for easier checks
      * if DOMPurify is up to date or not

diff --git a/dist/purify.es.d.mts b/dist/purify.es.d.mts
@@ -206,9 +206,9 @@ declare const _default: DOMPurify;
 
 interface DOMPurify {
     /**
-     * Creates a DOMPurify instance using the given window-like object.
+     * Creates a DOMPurify instance using the given window-like object. Defaults to `window`.
      */
-    (root: WindowLike): DOMPurify;
+    (root?: WindowLike): DOMPurify;
     /**
      * Version label, exposed for easier checks
      * if DOMPurify is up to date or not

diff --git a/src/purify.ts b/src/purify.ts
@@ -1679,9 +1679,9 @@ export default createDOMPurify();
 
 export interface DOMPurify {
   /**
-   * Creates a DOMPurify instance using the given window-like object.
+   * Creates a DOMPurify instance using the given window-like object. Defaults to `window`.
    */
-  (root: WindowLike): DOMPurify;
+  (root?: WindowLike): DOMPurify;
 
   /**
    * Version label, exposed for easier checks