API reference / @chanx-js/client / react / useTopics

Function: useTopics()

function useTopics<D, Refs>(descriptor, options): UseTopicsResult<ToServerOf<D>, Refs[number]>;

Defined in: packages/client/src/react/useTopics.ts:51

Join several topics over the channel's single connection: for a set that varies at runtime, which hooks cannot do one call per topic. For one topic, useTopic is simpler and fully typed.

useTopics(hub, { topics: rooms.map((room) => presence.with({ room })) });

lastMessage and messages are typed as any joined topic's messages, each tagged with its topic. Subscriptions are reference counted per resolved topic, and resume after a reconnect.

Type Parameters

Type Parameter
D extends ChannelDescriptor<any, any, any, any>
Refs extends readonly TopicRefOf<D>[]

Parameters

Parameter	Type
descriptor	D
options	UseTopicsOptions<AddressOf<D>, Refs[number]> & object

Returns

UseTopicsResult<ToServerOf<D>, Refs[number]>