Skip to main content

Overview

useCheckMyMembership returns a callable function that checks the authenticated user’s membership in a specific space without loading the full space object.

Usage Example

import { useCheckMyMembership } from "@replyke/react-js";

function MembershipBadge({ spaceId }: { spaceId: string }) {
  const checkMembership = useCheckMyMembership();

  const handleCheck = async () => {
    const result = await checkMembership({ spaceId });
    console.log(result.isMember, result.role, result.status);
  };
}

Parameters

spaceId
string
required
UUID of the space to check membership for.

Returns

isMember
boolean
Whether the user has an active membership.
role
"admin" | "moderator" | "member" | null
The user’s role. null if not a member.
status
"pending" | "active" | "banned" | "rejected" | null
The user’s membership status. null if no membership record exists.
joinedAt
Date | null
When the membership was created. null if not a member.
permissions
object
Resolved permissions: canPost, canModerate, canRead, isAdmin, isModerator.