Update deprecation notices in consumer components to specify type safety with context consumers

Author: timothygachengo

wp-react-lib/src/consumers/CategoriesConsumer.tsx

@@ -6,7 +6,7 @@ interface CategoriesConsumerProps {
 }
 
 /**
- * @deprecated Use the `CategoriesContext.Consumer` instead.
+ * @deprecated Use the `CategoriesContext.Consumer` instead if you want type safety.
  * CategoriesConsumer is a component that provides the categories, loading, error, and meta to its children.
  * @param props - The props for the CategoriesConsumer component.
  * @returns The CategoriesConsumer component.

wp-react-lib/src/consumers/MediaConsumer.tsx

@@ -6,6 +6,12 @@ interface MediaConsumerProps {
     children: React.ReactNode | React.ReactNode[] | React.ReactElement | React.ReactElement[];
 }
 
+/**
+ * @deprecated Use the `MediaContext.Consumer` instead if you want type safety.
+ * MediaConsumer is a component that provides the media, locale to its children.
+ * @param props - The props for the MediaConsumer component.
+ * @returns The MediaConsumer component.
+ */
 const MediaConsumer = (props: MediaConsumerProps) => {
     return (
         <MediaContext.Consumer>

wp-react-lib/src/consumers/PageConsumer.tsx

@@ -6,7 +6,7 @@ interface PageConsumerProps {
 }
 
 /**
- * @deprecated Use the `PageContext.Consumer` instead.
+ * @deprecated Use the `PageContext.Consumer` instead if you want type safety.
  * PageConsumer is a component that provides the pages, meta, and locale to its children.
  * @param props - The props for the PageConsumer component.
  * @returns The PageConsumer component.

wp-react-lib/src/consumers/PostConsumer.tsx

@@ -6,7 +6,7 @@ interface PostConsumerProps {
 }
 
 /**
- * @deprecated Use the `PostContext.Consumer` instead.
+ * @deprecated Use the `PostContext.Consumer` instead if you want type safety.
  * PostConsumer is a component that provides the posts, meta, and locale to its children.
  * @param props - The props for the PostConsumer component.
  * @returns The PostConsumer component.

wp-react-lib/src/consumers/SearchConsumer.tsx

@@ -6,7 +6,7 @@ interface SearchConsumerProps {
 }
 
 /**
- * @deprecated Use the `SearchContext.Consumer` instead.
+ * @deprecated Use the `SearchContext.Consumer` instead if you want type safety.
  * SearchConsumer is a component that provides the search results, meta, and locale to its children.
  * @param props - The props for the SearchConsumer component.
  * @returns The SearchConsumer component.

wp-react-lib/src/consumers/SettingsConsumer.tsx

@@ -6,7 +6,7 @@ interface SettingsConsumerProps {
 }
 
 /**
- * @deprecated Use the `SettingsContext.Consumer` instead.
+ * @deprecated Use the `SettingsContext.Consumer` instead if you want type safety.
  * SettingsConsumer is a component that provides the settings to its children.
  * @param props - The props for the SettingsConsumer component.
  * @returns The SettingsConsumer component.

wp-react-lib/src/consumers/TaxonomyConsumer.tsx

@@ -5,6 +5,12 @@ interface TaxonomyConsumerProps {
     children: React.ReactNode | React.ReactNode[] | React.ReactElement | React.ReactElement[];
 }
 
+/**
+ * @deprecated Use the `TaxonomyContext.Consumer` instead if you want type safety.
+ * TaxonomyConsumer is a component that provides the taxonomies, locale to its children.
+ * @param props - The props for the TaxonomyConsumer component.
+ * @returns The TaxonomyConsumer component.
+ */
 const TaxonomyConsumer = (props: TaxonomyConsumerProps) => {
     return (
         <TaxonomyContext.Consumer>