refactor: Rename useSetter into useMethod

Author: Asha20

lib/Session.tsx

@@ -3,7 +3,7 @@ import Talk from "talkjs";
 import { SessionContext } from "./SessionContext";
 import { SessionEvents } from "./types";
 import { EventListeners } from "./EventListeners";
-import { useSetter } from "./hooks";
+import { useMethod } from "./hooks";
 
 type UserProps =
   | { userId: string; syncUser?: undefined }
@@ -22,8 +22,14 @@ export function Session(props: SessionProps) {
   const [ready, markReady] = useState(false);
   const [session, setSession] = useState<Talk.Session>();
 
-  const { userId, syncUser, appId, signature, sessionRef, desktopNotificationEnabled } =
-    props;
+  const {
+    userId,
+    syncUser,
+    appId,
+    signature,
+    sessionRef,
+    desktopNotificationEnabled,
+  } = props;
 
   useEffect(() => {
     Talk.ready.then(() => markReady(true));
@@ -57,7 +63,7 @@ export function Session(props: SessionProps) {
     }
   }, [ready, appId, userId, syncUser, sessionRef]);
 
-  useSetter(
+  useMethod(
     session,
     desktopNotificationEnabled,
     "setDesktopNotificationEnabled",

lib/hooks.tsx

@@ -24,27 +24,27 @@ export function usePreviousIfDeeplyEqual<T>(val: T) {
 }
 
 /**
- * Calls method `setter` on `box` with `value`, iff `value` is set & deeply
+ * Calls method `method` on `box` with `value`, iff `value` is set & deeply
  * different from before (and the box is alive)
  */
-export function useSetter<
+export function useMethod<
   V,
   S extends string,
   T extends TalkObject & Record<S, (val: V) => any>,
->(box: T | undefined, value: V | undefined, setter: S) {
+>(box: T | undefined, value: V | undefined, method: S) {
   value = usePreviousIfDeeplyEqual(value);
   useEffect(() => {
     if (value !== undefined && box?.isAlive) {
-      box[setter](value);
+      box[method](value);
     }
-  }, [setter, box, value]);
+  }, [method, box, value]);
 }
 
 /**
- * Calls method `setter` on `box` with the arguments `args`, iff `args` is set &
- * deeply different from before (and the box is alive)
+ * Like {@link useMethod}, except `args` is an array that gets spread into
+ * the method call
  */
-export function useSpreadSetter<
+export function useSpreadMethod<
   V extends any[],
   S extends string,
   T extends TalkObject & Record<S, (...args: V) => any>,
@@ -77,10 +77,10 @@ export function useConversation<T extends Talk.UIBox>(
   }, [session, syncConversation, conversationId]);
 
   const args = (
-    conversation !== undefined ? [conversation, { asGuest }] : []
+    conversation !== undefined ? [conversation, { asGuest }] : undefined
   ) as any;
 
-  useSpreadSetter(box, args, "select");
+  useSpreadMethod(box, args, "select");
 }
 
 // subset of Session to help TypeScript pick the right overloads

lib/ui/Chatbox.tsx

@@ -2,7 +2,7 @@ import { CSSProperties, ReactNode } from "react";
 import type Talk from "talkjs";
 import { useSession } from "../SessionContext";
 import { getKeyForObject, splitObjectByPrefix } from "../util";
-import { useSetter, useConversation, useUIBox } from "../hooks";
+import { useMethod, useConversation, useUIBox } from "../hooks";
 import { FirstParameter, UIBoxProps } from "../types";
 import { MountedBox } from "../MountedBox";
 
@@ -48,9 +48,9 @@ function ActiveChatbox(props: ChatboxProps & { session: Talk.Session }) {
     options;
 
   const box = useUIBox(session, "createChatbox", simpleOptions, chatboxRef);
-  useSetter(box, messageFilter, "setMessageFilter");
-  useSetter(box, presence, "setPresence");
-  useSetter(box, highlightedWords, "setHighlightedWords");
+  useMethod(box, messageFilter, "setMessageFilter");
+  useMethod(box, presence, "setPresence");
+  useMethod(box, highlightedWords, "setHighlightedWords");
   useConversation(session, box, syncConversation, conversationId, asGuest);
 
   return (

lib/ui/Inbox.tsx

@@ -2,7 +2,7 @@ import { CSSProperties, ReactNode } from "react";
 import type Talk from "talkjs";
 import { useSession } from "../SessionContext";
 import { getKeyForObject, splitObjectByPrefix } from "../util";
-import { useSetter, useConversation, useUIBox } from "../hooks";
+import { useMethod, useConversation, useUIBox } from "../hooks";
 import { FirstParameter, UIBoxProps } from "../types";
 import { MountedBox } from "../MountedBox";
 
@@ -53,10 +53,10 @@ function ActiveInbox(props: InboxProps & { session: Talk.Session }) {
   } = options;
 
   const box = useUIBox(session, "createInbox", simpleOptions, inboxRef);
-  useSetter(box, messageFilter, "setMessageFilter");
-  useSetter(box, feedFilter, "setFeedFilter");
-  useSetter(box, presence, "setPresence");
-  useSetter(box, highlightedWords, "setHighlightedWords");
+  useMethod(box, messageFilter, "setMessageFilter");
+  useMethod(box, feedFilter, "setFeedFilter");
+  useMethod(box, presence, "setPresence");
+  useMethod(box, highlightedWords, "setHighlightedWords");
   useConversation(session, box, syncConversation, conversationId, asGuest);
 
   return (

lib/ui/Popup.tsx

@@ -1,7 +1,7 @@
 import Talk from "talkjs";
 import { useSession } from "../SessionContext";
 import { getKeyForObject, splitObjectByPrefix } from "../util";
-import { useSetter, useConversation, useUIBox, useMountBox } from "../hooks";
+import { useMethod, useConversation, useUIBox, useMountBox } from "../hooks";
 import { EventListeners } from "../EventListeners";
 import { UIBoxProps } from "../types";
 
@@ -36,9 +36,9 @@ function ActivePopup(props: PopupProps & { session: Talk.Session }) {
     options;
 
   const box = useUIBox(session, "createPopup", simpleOptions, popupRef);
-  useSetter(box, messageFilter, "setMessageFilter");
-  useSetter(box, presence, "setPresence");
-  useSetter(box, highlightedWords, "setHighlightedWords");
+  useMethod(box, messageFilter, "setMessageFilter");
+  useMethod(box, presence, "setPresence");
+  useMethod(box, highlightedWords, "setHighlightedWords");
   useConversation(session, box, syncConversation, conversationId, asGuest);
   useMountBox(box, undefined);