Add deprecation warnings to the unused hooks

GetStream · Dec 19, 2024 · 6e22447 · 6e22447
1 parent 56def19
commit 6e22447
Show file tree

Hide file tree

Showing 10 changed files with 30 additions and 0 deletions.
diff --git a/src/components/ChannelList/hooks/useChannelDeletedListener.ts b/src/components/ChannelList/hooks/useChannelDeletedListener.ts
@@ -6,6 +6,9 @@ import type { Channel, Event } from 'stream-chat';
 
 import type { DefaultStreamChatGenerics } from '../../../types/types';
 
+/**
+ * @deprecated Use `useChannelListShape` instead.
+ */
 export const useChannelDeletedListener = <
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics
 >(

diff --git a/src/components/ChannelList/hooks/useChannelHiddenListener.ts b/src/components/ChannelList/hooks/useChannelHiddenListener.ts
@@ -6,6 +6,9 @@ import type { Channel, Event } from 'stream-chat';
 
 import type { DefaultStreamChatGenerics } from '../../../types/types';
 
+/**
+ * @deprecated Use `useChannelListShape` instead.
+ */
 export const useChannelHiddenListener = <
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics
 >(

diff --git a/src/components/ChannelList/hooks/useChannelMembershipState.ts b/src/components/ChannelList/hooks/useChannelMembershipState.ts
@@ -3,6 +3,9 @@ import type { Channel, ChannelState, ExtendableGenerics } from 'stream-chat';
 
 import { useChatContext } from '../../../context';
 
+/**
+ * @deprecated Use `useChannelListShape` instead.
+ */
 export const useChannelMembershipState = <SCG extends ExtendableGenerics>(
   channel?: Channel<SCG>,
 ) => {

diff --git a/src/components/ChannelList/hooks/useChannelTruncatedListener.ts b/src/components/ChannelList/hooks/useChannelTruncatedListener.ts
@@ -6,6 +6,9 @@ import type { Channel, Event } from 'stream-chat';
 
 import type { DefaultStreamChatGenerics } from '../../../types/types';
 
+/**
+ * @deprecated Use `useChannelListShape` instead.
+ */
 export const useChannelTruncatedListener = <
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics
 >(

diff --git a/src/components/ChannelList/hooks/useChannelUpdatedListener.ts b/src/components/ChannelList/hooks/useChannelUpdatedListener.ts
@@ -6,6 +6,9 @@ import type { Channel, Event } from 'stream-chat';
 
 import type { DefaultStreamChatGenerics } from '../../../types/types';
 
+/**
+ * @deprecated Use `useChannelListShape` instead.
+ */
 export const useChannelUpdatedListener = <
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics
 >(

diff --git a/src/components/ChannelList/hooks/useChannelVisibleListener.ts b/src/components/ChannelList/hooks/useChannelVisibleListener.ts
@@ -9,6 +9,9 @@ import type { Channel, Event } from 'stream-chat';
 
 import type { DefaultStreamChatGenerics } from '../../../types/types';
 
+/**
+ * @deprecated Use `useChannelListShape` instead.
+ */
 export const useChannelVisibleListener = <
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics
 >(

diff --git a/src/components/ChannelList/hooks/useMessageNewListener.ts b/src/components/ChannelList/hooks/useMessageNewListener.ts
@@ -9,6 +9,9 @@ import type { Channel, Event } from 'stream-chat';
 
 import type { DefaultStreamChatGenerics } from '../../../types/types';
 
+/**
+ * @deprecated Use `useChannelListShape` instead.
+ */
 export const useMessageNewListener = <
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics
 >(

diff --git a/src/components/ChannelList/hooks/useNotificationAddedToChannelListener.ts b/src/components/ChannelList/hooks/useNotificationAddedToChannelListener.ts
@@ -9,6 +9,9 @@ import type { Channel, Event } from 'stream-chat';
 
 import type { DefaultStreamChatGenerics } from '../../../types/types';
 
+/**
+ * @deprecated Use `useChannelListShape` instead.
+ */
 export const useNotificationAddedToChannelListener = <
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics
 >(

diff --git a/src/components/ChannelList/hooks/useNotificationMessageNewListener.ts b/src/components/ChannelList/hooks/useNotificationMessageNewListener.ts
@@ -9,6 +9,9 @@ import type { Channel, Event } from 'stream-chat';
 
 import type { DefaultStreamChatGenerics } from '../../../types/types';
 
+/**
+ * @deprecated Use `useChannelListShape` instead.
+ */
 export const useNotificationMessageNewListener = <
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics
 >(

diff --git a/src/components/ChannelList/hooks/useNotificationRemovedFromChannelListener.ts b/src/components/ChannelList/hooks/useNotificationRemovedFromChannelListener.ts
@@ -6,6 +6,9 @@ import type { Channel, Event } from 'stream-chat';
 
 import type { DefaultStreamChatGenerics } from '../../../types/types';
 
+/**
+ * @deprecated Use `useChannelListShape` instead.
+ */
 export const useNotificationRemovedFromChannelListener = <
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics
 >(