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

Interface: UseChannelResult<ToServer, ToClient>

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

Type Parameters

Type Parameter
ToServer extends ChanxMessage
ToClient extends ChanxMessage

Properties

clearMessages

clearMessages: () => void;

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

Returns

void

---

connection

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

Defined in: packages/client/src/react/useChannel.ts:33

---

lastMessage

lastMessage: ToClient | null;

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

---

messages

messages: ToClient[];

Defined in: packages/client/src/react/useChannel.ts:29

---

request

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

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

Parameters

Parameter	Type
message	ToServer
options?	RequestOptions

Returns

Promise<ChanxMessage>

---

send

send: (message) => void;

Defined in: packages/client/src/react/useChannel.ts:31

Parameters

Parameter	Type
message	ToServer

Returns

void

---

status

status: SocketStatus;

Defined in: packages/client/src/react/useChannel.ts:27

---

terminate

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

Defined in: packages/client/src/react/useChannel.ts:35

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

Parameters

Parameter	Type
code?	number
reason?	string

Returns

void