API reference / @chanx-js/client / core / ChannelController

Interface: ChannelController<ToServer, ToClient>

Defined in: packages/client/src/core/controller.ts:88

Type Parameters

Type Parameter
ToServer extends ChanxMessage
ToClient extends ChanxMessage

Properties

clearMessages

clearMessages: () => void;

Defined in: packages/client/src/core/controller.ts:98

Returns

void

---

getConnection

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

Defined in: packages/client/src/core/controller.ts:99

Returns

| ChannelConnection<ToServer, ToClient> | null

---

getSnapshot

getSnapshot: () => ChannelSnapshot<ToClient>;

Defined in: packages/client/src/core/controller.ts:95

Stable between changes, so it can back useSyncExternalStore.

Returns

ChannelSnapshot<ToClient>

---

request

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

Defined in: packages/client/src/core/controller.ts:97

Parameters

Parameter	Type
message	ToServer
options?	RequestOptions

Returns

Promise<ChanxMessage>

---

send

send: (message) => void;

Defined in: packages/client/src/core/controller.ts:96

Parameters

Parameter	Type
message	ToServer

Returns

void

---

setOptions

setOptions: (options) => void;

Defined in: packages/client/src/core/controller.ts:103

Replace the options the handlers close over, without reconnecting.

Parameters

Parameter	Type
options	ControllerOptions<string, ToClient>

Returns

void

---

start

start: () => void;

Defined in: packages/client/src/core/controller.ts:106

Returns

void

---

stop

stop: () => void;

Defined in: packages/client/src/core/controller.ts:107

Returns

void

---

subscribe

subscribe: (listener) => () => void;

Defined in: packages/client/src/core/controller.ts:93

Subscribe to snapshot changes. Returns a disposer.

Parameters

Parameter	Type
listener	() => void

Returns

() => void

---

terminate

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

Defined in: packages/client/src/core/controller.ts:101

Close the socket for every consumer sharing it. See ChannelConnection.terminate.

Parameters

Parameter	Type
code?	number
reason?	string

Returns

void

---

url

readonly url: string | null;

Defined in: packages/client/src/core/controller.ts:105

The resolved URL, or null when disabled. Bindings key their lifecycle on this.