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

Interface: TopicsResult<ToServer, T>

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

Type Parameters

Type Parameter
ToServer extends ChanxMessage
T extends TopicRef

Properties

clearMessages

clearMessages: () => void;

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

Returns

void

---

close

close: () => void;

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

Returns

void

---

handles

handles: Accessor<Record<string, TopicHandle<ChanxMessage, ChanxMessage>>>;

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

---

lastMessage

lastMessage: Accessor<TopicMessage<T> | null>;

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

---

messages

messages: Accessor<TopicMessage<T>[]>;

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

---

request

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

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

Parameters

Parameter	Type
message	ToServer
options?	RequestOptions

Returns

Promise<ChanxMessage>

---

send

send: (message) => void;

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

Send on the channel itself, not on a topic.

Parameters

Parameter	Type
message	ToServer

Returns

void

---

sendTopic

sendTopic: (topic, message) => void;

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

Send on one of the joined topics, addressed by its resolved name.

Parameters

Parameter	Type
topic	string
message	ToServerOf<T>

Returns

void

---

status

status: Accessor<SocketStatus>;

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

---

subscribed

subscribed: Accessor<string[]>;

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

---

terminate

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

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

Close the socket for every consumer sharing it.

Parameters

Parameter	Type
code?	number
reason?	string

Returns

void