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

Interface: UseChannelResult<ToServer, ToClient>

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

Type Parameters

Type Parameter
ToServer extends ChanxMessage
ToClient extends ChanxMessage

Properties

clearMessages

clearMessages: () => void;

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

Returns

void

---

close

close: () => void;

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

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

Returns

void

---

connection

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

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

---

lastMessage

lastMessage: Ref<ToClient | null>;

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

---

messages

messages: Ref<ToClient[]>;

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

---

request

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

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

Parameters

Parameter	Type
message	ToServer
options?	RequestOptions

Returns

Promise<ChanxMessage>

---

send

send: (message) => void;

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

Parameters

Parameter	Type
message	ToServer

Returns

void

---

status

status: Ref<SocketStatus>;

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

---

terminate

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

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

Close the socket for every consumer sharing it.

Parameters

Parameter	Type
code?	number
reason?	string

Returns

void