API reference / @chanx-js/client / svelte / TopicsStore

Interface: TopicsStore<ToServer, T>

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

Extends

• Readable<TopicsSnapshot<T>>

Type Parameters

Type Parameter
ToServer extends ChanxMessage
T extends TopicRef

Properties

clearMessages

clearMessages: () => void;

Defined in: packages/client/src/svelte/index.ts:134

Returns

void

---

close

close: () => void;

Defined in: packages/client/src/svelte/index.ts:135

Returns

void

---

request

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

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

Parameters

Parameter	Type
message	ToServer
options?	RequestOptions

Returns

Promise<ChanxMessage>

---

send

send: (message) => void;

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

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/svelte/index.ts:132

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

Parameters

Parameter	Type
topic	string
message	ToServerOf<T>

Returns

void

---

terminate

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

Defined in: packages/client/src/svelte/index.ts:137

Close the socket for every consumer sharing it.

Parameters

Parameter	Type
code?	number
reason?	string

Returns

void

Methods

subscribe()

subscribe(
   this, 
   run, 
   invalidate?
): Unsubscriber;

Defined in: node_modules/.pnpm/svelte@5.57.1_@typescript-eslint+types@8.70.0/node_modules/svelte/types/index.d.ts:2769

Subscribe on value changes.

Parameters

Parameter	Type	Description
this	void	-
run	Subscriber<TopicsSnapshot<T>>	subscription callback
invalidate?	() => void	cleanup callback

Returns

Unsubscriber

Inherited from

Readable.subscribe