API reference / @chanx-js/server / core / Connection

Interface: Connection<Path, User>

Defined in: packages/server/src/consumer.ts:23

One client connection, as handlers and hooks see it.

Extends

• ConnectRequest<Path>

Type Parameters

Type Parameter	Default type
Path extends string	string
User	unknown

Properties

channelName

readonly channelName: string;

Defined in: packages/server/src/consumer.ts:32

This connection's channel on the layer: what sendEvent() targets.

---

groups

readonly groups: readonly string[];

Defined in: packages/server/src/consumer.ts:34

Groups joined, from the groups option and join().

---

headers

readonly headers: Headers;

Defined in: packages/server/src/consumer.ts:18

Inherited from

ConnectRequest.headers

---

id

readonly id: string;

Defined in: packages/server/src/consumer.ts:28

Unique per connection.

---

params

readonly params: PathParams<Path>;

Defined in: packages/server/src/consumer.ts:19

Inherited from

ConnectRequest.params

---

url

readonly url: URL;

Defined in: packages/server/src/consumer.ts:17

Inherited from

ConnectRequest.url

---

user

readonly user: User;

Defined in: packages/server/src/consumer.ts:30

What authenticate returned; undefined on a consumer without one.

Methods

broadcast()

broadcast(message, options?): Promise<void>;

Defined in: packages/server/src/consumer.ts:42

Send to every connection in the groups, as ctx.broadcast() does.

Parameters

Parameter	Type
message	Message
options?	BroadcastOptions

Returns

Promise<void>

---

close()

close(code?, reason?): void;

Defined in: packages/server/src/consumer.ts:43

Parameters

Parameter	Type
code?	number
reason?	string

Returns

void

---

join()

join(group): Promise<void>;

Defined in: packages/server/src/consumer.ts:36

Join a group at any time, such as on a client's request; its broadcasts then reach this connection.

Parameters

Parameter	Type
group	string

Returns

Promise<void>

---

leave()

leave(group): Promise<void>;

Defined in: packages/server/src/consumer.ts:38

Leave a group joined from the options or with join().

Parameters

Parameter	Type
group	string

Returns

Promise<void>

---

push()

push(message): Promise<void>;

Defined in: packages/server/src/consumer.ts:40

Send to this client as a server push, without a ref.

Parameters

Parameter	Type
message	Message

Returns

Promise<void>