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

Interface: ChannelStore<ToServer, ToClient>

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

Extends

• Readable<ChannelSnapshot<ToClient>>

Type Parameters

Type Parameter
ToServer extends ChanxMessage
ToClient extends ChanxMessage

Properties

clearMessages

clearMessages: () => void;

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

Returns

void

---

close

close: () => void;

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

Returns

void

---

getConnection

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

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

Returns

| ChannelConnection<ToServer, ToClient> | null

---

request

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

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

Parameters

Parameter	Type
message	ToServer
options?	RequestOptions

Returns

Promise<ChanxMessage>

---

send

send: (message) => void;

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

Parameters

Parameter	Type
message	ToServer

Returns

void

---

terminate

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

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

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<ChannelSnapshot<ToClient>>	subscription callback
invalidate?	() => void	cleanup callback

Returns

Unsubscriber

Inherited from

Readable.subscribe