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

Interface: UseTopicsResult<ToServer, T>

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

Type Parameters

Type Parameter
ToServer extends ChanxMessage
T extends TopicRef

Properties

clearMessages

clearMessages: () => void;

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

Returns

void

---

close

close: () => void;

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

Returns

void

---

handles

handles: Ref<Record<string, TopicHandle<ChanxMessage, ChanxMessage>>>;

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

---

lastMessage

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

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

---

messages

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

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

---

request

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

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

Parameters

Parameter	Type
message	ToServer
options?	RequestOptions

Returns

Promise<ChanxMessage>

---

send

send: (message) => void;

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

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/vue/index.ts:221

Send on one of the joined topics, addressed by its resolved name.

Parameters

Parameter	Type
topic	string
message	ToServerOf<T>

Returns

void

---

status

status: Ref<SocketStatus>;

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

---

subscribed

subscribed: Ref<string[]>;

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

---

terminate

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

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

Parameters

Parameter	Type
code?	number
reason?	string

Returns

void