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

Interface: UseTopicsResult<ToServer, Ref>

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

Extends

• TopicsSnapshot<Ref>

Type Parameters

Type Parameter
ToServer extends ChanxMessage
Ref extends TopicRef

Properties

clearMessages

clearMessages: () => void;

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

Returns

void

---

handles

handles: Record<string, TopicHandle>;

Defined in: packages/client/src/core/controller.ts:272

Inherited from

TopicsSnapshot.handles

---

lastMessage

lastMessage: 
  | TopicMessage<Ref>
  | null;

Defined in: packages/client/src/core/controller.ts:269

Inherited from

TopicsSnapshot.lastMessage

---

messages

messages: TopicMessage<Ref>[];

Defined in: packages/client/src/core/controller.ts:270

Inherited from

TopicsSnapshot.messages

---

request

request: (message, options?) => Promise<ChanxMessage>;

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

Parameters

Parameter	Type
message	ToServer
options?	RequestOptions

Returns

Promise<ChanxMessage>

---

send

send: (message) => void;

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

Send on the channel itself, not on a topic.

Parameters

Parameter	Type
message	ToServer

Returns

void

---

sendTopic

sendTopic: (topic, message) => void;

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

Send on one of the joined topics, addressed by its resolved name. For a send typed to exactly one topic, use useTopic, or take the handle from handles.

Parameters

Parameter	Type
topic	string
message	ToServerOf<Ref>

Returns

void

---

status

status: SocketStatus;

Defined in: packages/client/src/core/controller.ts:268

Inherited from

TopicsSnapshot.status

---

subscribed

subscribed: string[];

Defined in: packages/client/src/core/controller.ts:271

Inherited from

TopicsSnapshot.subscribed

---

terminate

terminate: (code?, reason?) => void;

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

Close the socket for every component sharing it, not just this one.

Parameters

Parameter	Type
code?	number
reason?	string

Returns

void