Add deprecation and explanation notice to composable

Co-authored-by: Zack Krida <[email protected]>
WordPress · Feb 27, 2024 · 1f86352 · 1f86352
1 parent 683da43
commit 1f86352
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/frontend/src/composables/use-analytics.ts b/frontend/src/composables/use-analytics.ts
@@ -1,5 +1,11 @@
 import { useContext } from "@nuxtjs/composition-api"
 
+/**
+ * This wrapper around the plugin, retained to reduce code churn.
+ * 
+ * @deprecated For new code, use `$sendCustomEvent` from Nuxt context
+ * @see {@link ~/plugins/analytics.ts} for plugin implementation
+ */
 export const useAnalytics = () => {
   const { $sendCustomEvent } = useContext()