useMemberList

Hook to get the members userIds of a Space, GDM, Channel, or DM. Used with useMember to get data from a specific member.

​

Imports

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

​

Definition

function useMemberList(
  streamId: string,
  config?: ObservableConfig.FromData<MembersModel>,
): ObservableValue<MembersModel>

Source: useMemberList

​

Parameters

​

streamId

• Type: string

The id of the stream to get the members of.

​

config

• Type: ObservableConfig.FromData<MembersModel>
• Optional

Configuration options for the observable.

​

Return Type

The MembersModel of the stream, containing the userIds of the members.

ObservableValue<MembersModel>