chore: add JSDocs as well

Author: isekovanic

src/components/AIStateIndicator/hooks/useAIState.ts

@@ -12,11 +12,16 @@ export const AIStates = {
   Thinking: 'AI_STATE_THINKING',
 };
 
+/**
+ * A hook that returns the current state of the AI.
+ * @param {Channel} channel - The channel for which we want to know the AI state.
+ * @returns {{ aiState: AIState }} The current AI state for the given channel.
+ */
 export const useAIState = <
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics
 >(
   channel?: Channel<StreamChatGenerics>,
-) => {
+): { aiState: AIState } => {
   const [aiState, setAiState] = useState<AIState>(AIStates.Idle);
 
   useEffect(() => {

src/components/Message/hooks/useMessageTextStreaming.ts

@@ -13,13 +13,21 @@ export type UseMessageTextStreamingProps<
 const DEFAULT_LETTER_INTERVAL = 30;
 const DEFAULT_RENDERING_LETTER_COUNT = 2;
 
+/**
+ * A hook that returns text in a streamed, typewriter fashion. The speed of streaming is
+ * configurable.
+ * @param {number} [streamingLetterIntervalMs=30] - The timeout between each typing animation in milliseconds.
+ * @param {number} [renderingLetterCount=2] - The number of letters to be rendered each time we update.
+ * @param {string} text - The text that we want to render in a typewriter fashion.
+ * @returns {{ streamedMessageText: string }} - A substring of the text property, up until we've finished rendering the typewriter animation.
+ */
 export const useMessageTextStreaming = <
   StreamChatGenerics extends DefaultStreamChatGenerics = DefaultStreamChatGenerics
 >({
   streamingLetterIntervalMs = DEFAULT_LETTER_INTERVAL,
   renderingLetterCount = DEFAULT_RENDERING_LETTER_COUNT,
   text,
-}: UseMessageTextStreamingProps<StreamChatGenerics>) => {
+}: UseMessageTextStreamingProps<StreamChatGenerics>): { streamedMessageText: string } => {
   const [streamedMessageText, setStreamedMessageText] = useState<string>(text);
   const textCursor = useRef<number>(text.length);