Deprecate matchMediaQuery()

21TORR · May 7, 2024 · 4272c2a · 4272c2a
1 parent 6ef23dc
commit 4272c2a
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,9 @@
+2.2.2
+=====
+
+* (deprecation) Deprecate `matchMediaQuery()`, use `window.matchMedia()` directly.
+
+
 2.2.1
 =====
 

diff --git a/UPGRADE.md b/UPGRADE.md
@@ -2,6 +2,7 @@
 ==========
 
 * The `createEvent` helper was removed, use `new CustomEvent()` directly.
+* Removed `matchMediaQuery()`, use `window.matchMedia()` directly.
 
 
 1.x to 2.0

diff --git a/src/media-query.ts b/src/media-query.ts
@@ -11,6 +11,8 @@ export interface MediaQueryMatcher
 
 /**
  * Creates a new media query matcher
+ *
+ * @deprecated just use `matchMedia` directly.
  */
 export function matchMediaQuery (query: string): MediaQueryMatcher
 {