Deprecate obscure helpers

CHANGELOG.md

@@ -1,3 +1,10 @@
+2.2.2
+=====
+
+* (deprecation) Deprecate `matchMediaQuery()`, use `window.matchMedia()` directly.
+* (deprecation) Deprecate `addConsecutiveClasses()`, use Framer Motion or a different animation library instead.
+
+
 2.2.1
 =====
 

UPGRADE.md

@@ -2,6 +2,8 @@
 ==========
 
 * The `createEvent` helper was removed, use `new CustomEvent()` directly.
+* Removed `matchMediaQuery()`, use `window.matchMedia()` directly.
+* Removed `addConsecutiveClasses()`, use Framer Motion or a different animation library instead.
 
 
 1.x to 2.0

src/animation.ts

@@ -1,5 +1,7 @@
 /**
  * Adds two classes in consecutive animation frames.
+ *
+ * @deprecated use Framer Motion or a different animation library instead
  */
 export function addConsecutiveClasses (
 	element: HTMLElement,

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
 {

src/popup-interaction.ts

@@ -2,6 +2,9 @@ import {off, on} from './dom/events';
 import {isChildOf} from './dom/traverse';
 
 export interface DismissibleContainerDirector {
+	/**
+	 * Close function
+	 */
 	(): void;
 	destroy(): void;
 }
@@ -12,7 +15,10 @@ export interface DismissibleContainerDirector {
  *
  * Returns a callback to remove the listener.
  */
-export function registerBodyClickHandler (allowedClickTargets: HTMLElement[], onInvalidTargetClick: () => void) : () => void
+export function registerBodyClickHandler (
+	allowedClickTargets: HTMLElement[],
+	onInvalidTargetClick: () => void,
+) : () => void
 {
 	let handler = (event: Event) => {
 		for (let i = 0; i < allowedClickTargets.length; i++)