Hook to get the data of the current user in a stream.

​
Imports

import { useMyMember } from '@towns-protocol/react-sdk'

​
Definition

function useMyMember(
  streamId: string,
  config?: ObservableConfig.FromObservable<Member>,
): {
    id: string;
    userId: string;
    streamId: string;
    initialized: boolean;
    username: string;
    isUsernameConfirmed: boolean;
    isUsernameEncrypted: boolean;
    displayName: string;
    isDisplayNameEncrypted?: boolean;
    ensAddress?: string;
    nft?: NftModel;
    membership?: MembershipOp;
}

Source: useMyMember

​
Parameters

​
streamId

  • Type: string

The id of the stream to get the current user of.

​
config

  • Type: ObservableConfig.FromObservable<Member>
  • Optional

Configuration options for the observable.

​
Return Type

The MemberModel of the current user.

{
    id: string;
    userId: string;
    streamId: string;
    initialized: boolean;
    username: string;
    isUsernameConfirmed: boolean;
    isUsernameEncrypted: boolean;
    displayName: string;
    isDisplayNameEncrypted?: boolean;
    ensAddress?: string;
    nft?: NftModel;
    membership?: MembershipOp;
}

Was this page helpful?