API reference / @chanx-js/client / solid / ChannelResult

Interface: ChannelResult<ToServer, ToClient, Replies>

Defined in: packages/client/src/solid/index.ts:55

Type Parameters

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

Properties

clearMessages

clearMessages: () => void;

Defined in: packages/client/src/solid/index.ts:63

Returns

void

---

close

close: () => void;

Defined in: packages/client/src/solid/index.ts:67

Returns

void

---

connection

connection: () => 
  | ChannelConnection<ToServer, ToClient, Replies>
  | null;

Defined in: packages/client/src/solid/index.ts:66

Returns

| ChannelConnection<ToServer, ToClient, Replies> | null

---

lastMessage

lastMessage: Accessor<ToClient | null>;

Defined in: packages/client/src/solid/index.ts:61

---

messages

messages: Accessor<ToClient[]>;

Defined in: packages/client/src/solid/index.ts:62

---

request

request: RequestFn<ToServer, Replies>;

Defined in: packages/client/src/solid/index.ts:65

---

send

send: (message) => void;

Defined in: packages/client/src/solid/index.ts:64

Parameters

Parameter	Type
message	ToServer

Returns

void

---

status

status: Accessor<SocketStatus>;

Defined in: packages/client/src/solid/index.ts:60

---

terminate

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

Defined in: packages/client/src/solid/index.ts:69

Close the socket for every consumer sharing it.

Parameters

Parameter	Type
code?	number
reason?	string

Returns

void