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

Interface: TopicsController<ToServer, Ref>

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

Type Parameters

Type Parameter	Default type
ToServer extends ChanxMessage	-
Ref extends TopicRef	TopicRef

Properties

clearMessages

clearMessages: () => void;

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

Returns

void

---

getSnapshot

getSnapshot: () => TopicsSnapshot<Ref>;

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

Returns

TopicsSnapshot<Ref>

---

request

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

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

Parameters

Parameter	Type
message	ToServer
options?	RequestOptions

Returns

Promise<ChanxMessage>

---

send

send: (message) => void;

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

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/core/controller.ts:284

Send on a joined topic, addressed by its resolved name.

Parameters

Parameter	Type
topic	string
message	ToServerOf<Ref>

Returns

void

---

setOptions

setOptions: (options) => void;

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

Parameters

Parameter	Type
options	TopicsControllerOptions<string, Ref>

Returns

void

---

start

start: () => void;

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

Returns

void

---

stop

stop: () => void;

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

Returns

void

---

subscribe

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

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

Parameters

Parameter	Type
listener	() => void

Returns

() => void

---

terminate

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

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

Parameters

Parameter	Type
code?	number
reason?	string

Returns

void

---

topicKey

readonly topicKey: string;

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

Identity of the topic set, so bindings can restart only when it really changes.

---

url

readonly url: string | null;

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