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

Interface: UseChannelResult<ToServer, ToClient, Replies>

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

Type Parameters

Type Parameter	Default type
ToServer extends ChanxMessage	-
ToClient extends ChanxMessage	-
Replies	NoReplies

Properties

clearMessages

clearMessages: () => void;

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

Returns

void

---

close

close: () => void;

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

Release this consumer's claim; the socket stays up for any others.

Returns

void

---

connection

connection: Ref<
  | ChannelConnection<ToServer, ToClient, Replies>
| null>;

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

---

lastMessage

lastMessage: Ref<ToClient | null>;

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

---

messages

messages: Ref<ToClient[]>;

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

---

request

request: RequestFn<ToServer, Replies>;

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

---

send

send: (message) => void;

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

Parameters

Parameter	Type
message	ToServer

Returns

void

---

status

status: Ref<SocketStatus>;

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

---

terminate

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

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

Close the socket for every consumer sharing it.

Parameters

Parameter	Type
code?	number
reason?	string

Returns

void