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

Interface: UseTopicResult<T>

Defined in: packages/client/src/vue/index.ts:316

Type Parameters

Type Parameter
T extends TopicRef

Properties

clearMessages

clearMessages: () => void;

Defined in: packages/client/src/vue/index.ts:323

Returns

void

---

close

close: () => void;

Defined in: packages/client/src/vue/index.ts:328

Returns

void

---

handle

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

Defined in: packages/client/src/vue/index.ts:322

The topic's handle while joined.

---

lastMessage

lastMessage: Ref<TopicMessage<T> | null>;

Defined in: packages/client/src/vue/index.ts:319

---

messages

messages: Ref<TopicMessage<T>[]>;

Defined in: packages/client/src/vue/index.ts:320

---

request

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

Defined in: packages/client/src/vue/index.ts:327

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

Parameters

Parameter	Type
message	ToServerOf<T>
options?	RequestOptions

Returns

Promise<ChanxMessage>

---

send

send: (message) => void;

Defined in: packages/client/src/vue/index.ts:325

Send on the topic.

Parameters

Parameter	Type
message	ToServerOf<T>

Returns

void

---

status

status: Ref<SocketStatus>;

Defined in: packages/client/src/vue/index.ts:317

---

subscribed

subscribed: Ref<boolean>;

Defined in: packages/client/src/vue/index.ts:318

---

terminate

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

Defined in: packages/client/src/vue/index.ts:329

Parameters

Parameter	Type
code?	number
reason?	string

Returns

void