React Hooks (v1)

This documents the old v1 API. See React Hooks for the current version.

useClient

const client = zocket.useClient();

useConnectionState

const { status, lastError } = zocket.useConnectionState();
// status: "connecting" | "open" | "closed"

useEvent

zocket.useEvent(client.on.chat.message, (msg) => {
  setMessages(prev => [...prev, msg]);
});

Data Fetching (TanStack Query)

import { useQuery } from "@tanstack/react-query";

function Profile({ userId }) {
  const client = zocket.useClient();
  const profile = useQuery({
    queryKey: ["users.getProfile", userId],
    queryFn: () => client.users.getProfile({ id: userId }),
  });
  return <pre>{JSON.stringify(profile.data, null, 2)}</pre>;
}