@river-build/react-sdk
Version:
React Hooks for River SDK
64 lines • 2.16 kB
TypeScript
import { Member } from '@river-build/sdk';
import type { ObservableConfig } from './useObservable';
/**
* Hook to get data from a specific member of a Space, GDM, Channel, or DM.
* @param props - The streamId and userId of the member to get data from.
* @param config - Configuration options for the observable.
* @returns The Member data.
*/
export declare const useMember: (props: {
streamId: string;
userId: string;
}, config?: ObservableConfig.FromObservable<Member>) => {
error: Error | undefined;
status: "error" | "loading" | "loaded";
isLoading: boolean;
isError: boolean;
isLoaded: boolean;
userId: string;
streamId: string;
initialized: boolean;
username: string;
isUsernameConfirmed: boolean;
isUsernameEncrypted: boolean;
displayName: string;
isDisplayNameEncrypted: boolean | undefined;
ensAddress: string | undefined;
nft: import("@river-build/sdk").NftModel | undefined;
membership: import("@river-build/proto").MembershipOp | undefined;
} | {
error: Error | undefined;
status: "error" | "loading" | "loaded";
isLoading: boolean;
isError: boolean;
isLoaded: boolean;
userId: string;
streamId: string;
initialized: boolean;
username: string;
isUsernameConfirmed: boolean;
isUsernameEncrypted: boolean;
displayName: string;
isDisplayNameEncrypted: boolean | undefined;
ensAddress: string | undefined;
nft: import("@river-build/sdk").NftModel | undefined;
membership: import("@river-build/proto").MembershipOp | undefined;
} | {
error: Error | undefined;
status: "error" | "loading" | "loaded";
isLoading: boolean;
isError: boolean;
isLoaded: boolean;
userId: string;
streamId: string;
initialized: boolean;
username: string;
isUsernameConfirmed: boolean;
isUsernameEncrypted: boolean;
displayName: string;
isDisplayNameEncrypted: boolean | undefined;
ensAddress: string | undefined;
nft: import("@river-build/sdk").NftModel | undefined;
membership: import("@river-build/proto").MembershipOp | undefined;
};
//# sourceMappingURL=useMember.d.ts.map