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

Interface: Chanx

Defined in: packages/server/src/app.ts:92

Methods

asyncapi()

asyncapi(options?): AsyncAPIDocument;

Defined in: packages/server/src/app.ts:125

The AsyncAPI 3 document for these consumers, for docs and @chanx-js/codegen.

Parameters

Parameter	Type
options?	AsyncAPIOptions

Returns

AsyncAPIDocument

---

broadcastEvent()

broadcastEvent<C>(
   consumer, 
   event, 
   groups?
): Promise<void>;

Defined in: packages/server/src/app.ts:109

Send an event to a consumer's groups, from anywhere: a request handler, a worker, another process. Groups default to the consumer's own.

Type Parameters

Type Parameter
C extends ConsumerLike

Parameters

Parameter	Type
consumer	C
event	EventsOf<C>
groups?	readonly string[]

Returns

Promise<void>

---

connect()

connect(request, transport): Session | undefined;

Defined in: packages/server/src/app.ts:101

Serve an accepted socket. Returns undefined when no consumer serves the URL.

Parameters

Parameter	Type
request	| UpgradeRequest | AcceptedUpgrade
transport	Transport

Returns

Session | undefined

---

match()

match(path): boolean;

Defined in: packages/server/src/app.ts:94

Whether a path belongs to a consumer, so an adapter can leave other upgrades alone.

Parameters

Parameter	Type
path	string

Returns

boolean

---

publish()

publish<T>(
   topic, 
   value, 
   event, 
   options?
): Promise<void>;

Defined in: packages/server/src/app.ts:118

Publish an event to everyone subscribed to a topic, from anywhere. seq is caller-assigned, for gap detection only.

Type Parameters

Type Parameter
T extends TopicLike

Parameters

Parameter	Type
topic	T
value	string
event	EventsOf<T>
options?	PublishOptions

Returns

Promise<void>

---

sendEvent()

sendEvent<C>(
   consumer, 
   event, 
   channelName
): Promise<void>;

Defined in: packages/server/src/app.ts:127

Send an event to one connection, by its channelName.

Type Parameters

Type Parameter
C extends ConsumerLike

Parameters

Parameter	Type
consumer	C
event	EventsOf<C>
channelName	string

Returns

Promise<void>

---

upgrade()

upgrade(request): Promise<
  | AcceptedUpgrade
  | RefusedUpgrade
| undefined>;

Defined in: packages/server/src/app.ts:99

Decide on an upgrade before completing it: undefined when no consumer serves the URL, else accepted or, for a consumer with rejectBeforeUpgrade, possibly refused.

Parameters

Parameter	Type
request	UpgradeRequest

Returns

Promise< | AcceptedUpgrade | RefusedUpgrade | undefined>