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

Interface: UseTopicResult<Ref>

Defined in: packages/client/src/react/useTopic.ts:23

Extends

• TopicSnapshot<Ref>

Type Parameters

Type Parameter
Ref extends TopicRef

Properties

clearMessages

clearMessages: () => void;

Defined in: packages/client/src/react/useTopic.ts:24

Returns

void

---

handle

handle: 
  | TopicHandle<ToServerOf<Ref>, ToClientOf<Ref>>
  | null;

Defined in: packages/client/src/react/useTopic.ts:30

The topic's handle while joined.

---

lastMessage

lastMessage: 
  | TopicMessage<Ref>
  | null;

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

Inherited from

TopicSnapshot.lastMessage

---

messages

messages: TopicMessage<Ref>[];

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

Inherited from

TopicSnapshot.messages

---

request

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

Defined in: packages/client/src/react/useTopic.ts:28

Send on the topic and wait for the reply carrying the same ref.

Parameters

Parameter	Type
message	ToServerOf<Ref>
options?	RequestOptions

Returns

Promise<ChanxMessage>

---

send

send: (message) => void;

Defined in: packages/client/src/react/useTopic.ts:26

Send on the topic.

Parameters

Parameter	Type
message	ToServerOf<Ref>

Returns

void

---

status

status: SocketStatus;

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

Inherited from

TopicSnapshot.status

---

subscribed

subscribed: boolean;

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

Whether the server has confirmed the subscription.

Inherited from

TopicSnapshot.subscribed

---

terminate

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

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

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

Parameters

Parameter	Type
code?	number
reason?	string

Returns

void