API reference / @chanx-js/client / solid / TopicResult

Interface: TopicResult<T>

Defined in: packages/client/src/solid/index.ts:182

Type Parameters

Type Parameter
T extends TopicRef

Properties

clearMessages

clearMessages: () => void;

Defined in: packages/client/src/solid/index.ts:189

Returns

void

---

close

close: () => void;

Defined in: packages/client/src/solid/index.ts:194

Returns

void

---

handle

handle: () => 
  | TopicHandle<ToServerOf<T>, ToClientOf<T>>
  | null;

Defined in: packages/client/src/solid/index.ts:188

The topic's handle while joined.

Returns

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

---

lastMessage

lastMessage: Accessor<TopicMessage<T> | null>;

Defined in: packages/client/src/solid/index.ts:185

---

messages

messages: Accessor<TopicMessage<T>[]>;

Defined in: packages/client/src/solid/index.ts:186

---

request

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

Defined in: packages/client/src/solid/index.ts:193

Send on the topic and wait for the reply carrying the same ref.

Parameters

Parameter	Type
message	ToServerOf<T>
options?	RequestOptions

Returns

Promise<ChanxMessage>

---

send

send: (message) => void;

Defined in: packages/client/src/solid/index.ts:191

Send on the topic.

Parameters

Parameter	Type
message	ToServerOf<T>

Returns

void

---

status

status: Accessor<SocketStatus>;

Defined in: packages/client/src/solid/index.ts:183

---

subscribed

subscribed: Accessor<boolean>;

Defined in: packages/client/src/solid/index.ts:184

---

terminate

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

Defined in: packages/client/src/solid/index.ts:196

Close the socket for every consumer sharing it.

Parameters

Parameter	Type
code?	number
reason?	string

Returns

void