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

Interface: ChannelResult<ToServer, ToClient>

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

Type Parameters

Type Parameter
ToServer extends ChanxMessage
ToClient extends ChanxMessage

Properties

clearMessages

clearMessages: () => void;

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

Returns

void

---

close

close: () => void;

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

Returns

void

---

connection

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

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

Returns

| ChannelConnection<ToServer, ToClient> | null

---

lastMessage

lastMessage: Accessor<ToClient | null>;

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

---

messages

messages: Accessor<ToClient[]>;

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

---

request

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

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

Parameters

Parameter	Type
message	ToServer
options?	RequestOptions

Returns

Promise<ChanxMessage>

---

send

send: (message) => void;

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

Parameters

Parameter	Type
message	ToServer

Returns

void

---

status

status: Accessor<SocketStatus>;

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

---

terminate

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

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

Close the socket for every consumer sharing it.

Parameters

Parameter	Type
code?	number
reason?	string

Returns

void