API reference / @chanx-js/nestjs / ChanxService

Class: ChanxService

Defined in: packages/nestjs/src/service.ts:13

Send events and publish to topics from anywhere in the app, typed by message.

Constructors

Constructor

new ChanxService(): ChanxService;

Returns

ChanxService

Methods

asyncapi()

asyncapi(options?): AsyncAPIDocument;

Defined in: packages/nestjs/src/service.ts:60

Parameters

Parameter	Type
options?	AsyncAPIOptions

Returns

AsyncAPIDocument

---

attach()

attach(app, sources): void;

Defined in: packages/nestjs/src/service.ts:18

Called by the explorer once the gateways are built.

Parameters

Parameter	Type
app	Chanx
sources	Map<Type<any>, object>

Returns

void

---

broadcastEvent()

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

Defined in: packages/nestjs/src/service.ts:24

Send an event to a consumer's groups, across processes.

Parameters

Parameter	Type
consumer	Type
event	Message
groups?	readonly string[]

Returns

Promise<void>

---

publish()

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

Defined in: packages/nestjs/src/service.ts:46

Publish an event to everyone subscribed to a topic, across processes.

Parameters

Parameter	Type
topic	Type
value	string
event	Message
options?	PublishOptions

Returns

Promise<void>

---

sendEvent()

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

Defined in: packages/nestjs/src/service.ts:37

Send an event to one connection, by its channelName.

Parameters

Parameter	Type
consumer	Type
event	Message
channelName	string

Returns

Promise<void>