Fix useLocalAwareness & useRemoteAwareness types #436
Conversation
| import { useEffect } from "react" | ||
| import useStateRef from "react-usestateref" | ||
| import { peerEvents } from "./useRemoteAwareness.js" | ||
| import { peerEvents } from "./useRemoteAwareness" |
There was a problem hiding this comment.
Nah, I think we can roll in other minor cleanup.
| export const useLocalAwareness = ({ | ||
| handle, | ||
| export const useLocalAwareness = <T>({ | ||
| handle?, |
There was a problem hiding this comment.
separate commit? (as well as optional chaining)
There was a problem hiding this comment.
No need for a separate commit, but why the ? here? I don't think I know that syntax.
| ) | ||
| const [heartbeats, setHeartbeats, heartbeatsRef] = useStateRef<Heartbeats>({}) | ||
| useEffect(() => { | ||
| if (!handle) return |
There was a problem hiding this comment.
separate commit? also add braces
There was a problem hiding this comment.
I personally prefer braces, but if it passes linting, this is okay by me. We can litigate that separately. No need for a separate commit.
| import { useEffect } from "react" | ||
| import useStateRef from "react-usestateref" | ||
| import { peerEvents } from "./useRemoteAwareness.js" | ||
| import { peerEvents } from "./useRemoteAwareness" |
There was a problem hiding this comment.
Nah, I think we can roll in other minor cleanup.
| export const useLocalAwareness = ({ | ||
| handle, | ||
| export const useLocalAwareness = <T>({ | ||
| handle?, |
There was a problem hiding this comment.
No need for a separate commit, but why the ? here? I don't think I know that syntax.
| }: UseLocalAwarenessProps<T>): [ | ||
| T, | ||
| (stateOrUpdater: T | StateUpdater<T>) => void | ||
| ] => { |
There was a problem hiding this comment.
Since we're following React patterns for these hooks, it would be good to return
[ T, React.Dispatch<React.SetStateAction<T>> ]from them.
| handle?: DocHandle<unknown> | ||
| /** Our user ID - Automerge BroadcastChannel sometimes sends us our own messages; optionally filters them */ |
There was a problem hiding this comment.
This comment feels out of place. Maybe it should be here instead, but it's fairly clear what's going on there...
| handle?: DocHandle<unknown> | |
| /** Our user ID - Automerge BroadcastChannel sometimes sends us our own messages; optionally filters them */ | |
| handle?: DocHandle<unknown> | |
| /** Our user ID */ |
| /** How long to wait (in ms) before marking a peer as offline */ | ||
| offlineTimeout?: number | ||
| /** Function to provide current epoch time */ | ||
| /** Function to provide current epoch time (used for testing) */ |
There was a problem hiding this comment.
Probably a slightly bigger (and separate) project, but I wonder if we can use mockdate or another similar package instead to avoid this API wart. I've had a pretty good experience with mockdate in the past.
| ) | ||
| const [heartbeats, setHeartbeats, heartbeatsRef] = useStateRef<Heartbeats>({}) | ||
| useEffect(() => { | ||
| if (!handle) return |
There was a problem hiding this comment.
I personally prefer braces, but if it passes linting, this is okay by me. We can litigate that separately. No need for a separate commit.
| event: DocHandleEphemeralMessagePayload<T> | ||
| event: DocHandleEphemeralMessagePayload<unknown> | ||
| ) => { | ||
| const [userId, state] = event.message as [string, unknown] | ||
| const [userId, state] = event.message as [string, T] |
There was a problem hiding this comment.
I don't understand these changes. Can you clarify?
|
Hey! Thanks for the review. I will be 100% continuing work, but it will be a couple of months before I have the bandwidth to focus on this again :) |
|
@neftaly hey, no problem. Just follow up when you're ready. |
No description provided.