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

Interface: ChannelDescriptor<ToServer, ToClient, Address, Topics>

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

Type Parameters

Type Parameter	Default type
ToServer extends ChanxMessage	ChanxMessage
ToClient extends ChanxMessage	ChanxMessage
Address extends string	string
Topics extends TopicMap	TopicMap

Properties

address

readonly address: Address;

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

---

heartbeat?

readonly optional heartbeat?: boolean;

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

The channel answers ping with pong, so a heartbeat is safe to run on it.

---

kind

readonly kind: "channel";

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

---

name

readonly name: string;

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

---

topics

readonly topics: Topics;

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

---

types?

readonly optional types?: object;

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

toClient

toClient: ToClient;

toServer

toServer: ToServer;

---

validators?

readonly optional validators?: Validators<ToServer, ToClient>;

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