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

Interface: TopicRef<ToServer, ToClient, Pattern>

Defined in: packages/client/src/core/descriptor.ts:53

A topic with its params filled in, from topic.with(params). What gets joined.

Type Parameters

Type Parameter	Default type
ToServer extends ChanxMessage	ChanxMessage
ToClient extends ChanxMessage	ChanxMessage
Pattern extends string	string

Properties

descriptor

readonly descriptor: TopicDescriptor<ToServer, ToClient, Pattern>;

Defined in: packages/client/src/core/descriptor.ts:58

---

params

readonly params: Record<string, string | number>;

Defined in: packages/client/src/core/descriptor.ts:59

---

topic

readonly topic: string;

Defined in: packages/client/src/core/descriptor.ts:61

The resolved topic string, such as room:lobby.