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

Interface: TopicController<Ref>

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

Type Parameters

Type Parameter	Default type
Ref extends TopicRef	TopicRef

Properties

clearMessages

clearMessages: () => void;

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

Returns

void

---

getHandle

getHandle: () => 
  | TopicHandle<ToServerOf<Ref>, ToClientOf<Ref>>
  | null;

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

The topic's handle while joined, for everything else a handle offers.

Returns

| TopicHandle<ToServerOf<Ref>, ToClientOf<Ref>> | null

---

getSnapshot

getSnapshot: () => TopicSnapshot<Ref>;

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

Returns

TopicSnapshot<Ref>

---

request

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

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

Parameters

Parameter	Type
message	ToServerOf<Ref>
options?	RequestOptions

Returns

Promise<ChanxMessage>

---

send

send: (message) => void;

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

Send on the topic. Dropped when it is not joined (disabled, or not started).

Parameters

Parameter	Type
message	ToServerOf<Ref>

Returns

void

---

setOptions

setOptions: (options) => void;

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

Parameters

Parameter	Type
options	TopicControllerOptions<string, Ref>

Returns

void

---

start

start: () => void;

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

Returns

void

---

stop

stop: () => void;

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

Returns

void

---

subscribe

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

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

Parameters

Parameter	Type
listener	() => void

Returns

() => void

---

terminate

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

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

Parameters

Parameter	Type
code?	number
reason?	string

Returns

void

---

topicKey

readonly topicKey: string;

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

The resolved topic, so bindings can rejoin only when it changes.

---

url

readonly url: string | null;

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