@river-build/react-sdk
Version:
React Hooks for River SDK
32 lines • 1.12 kB
TypeScript
import type { MembersModel } from '@river-build/sdk';
import { type ObservableConfig } from './useObservable';
/**
* Hook to get the members userIds of a Space, GDM, Channel, or DM.
* Used with useMember to get data from a specific member.
* @param streamId - The id of the stream to get the members of.
* @param config - Configuration options for the observable.
* @returns The MembersModel of the stream, containing the userIds of the members.
*/
export declare const useMemberList: (streamId: string, config?: ObservableConfig.FromData<MembersModel>) => {
data: MembersModel;
error: Error | undefined;
status: "error" | "loading" | "loaded";
isLoading: boolean;
isError: boolean;
isLoaded: boolean;
} | {
data: MembersModel;
error: Error | undefined;
status: "error" | "loading" | "loaded";
isLoading: boolean;
isError: boolean;
isLoaded: boolean;
} | {
data: MembersModel;
error: Error | undefined;
status: "error" | "loading" | "loaded";
isLoading: boolean;
isError: boolean;
isLoaded: boolean;
};
//# sourceMappingURL=useMemberList.d.ts.map