Event Emitter

A package to emit events to JANIS Events

Installation

npm install @janiscommerce/event-emitter

Configuration

ENV variables

JANIS_SERVICE_NAME (required): The name of the service that will emit the event.

Important

This package uses @janiscommerce/microservice-call, it's strongly recommended to read this package docs before continue.

API

emit(event)

Emits an event to janis-events. Returns an object with a boolean property result set to true if the operation is successful, false otherwise, and a response property with the MS Call response.

Event parameter

The event parameter is an [Object] and have the following structure:

• entity [String] (required): The name of the entity that is emitting the event.
• event [String] (required): The event name.
• client [String] (optional): The client code name.
• id [Number|String|Array of Strings|Array of Numbers] (optional): The ID or ID's of the entity that is emitting the event.

Errors

The errors are informed with a EventEmitterError. This object has a code that can be useful for a correct error handling. The codes are the following:

| Code | Description | |------|--------------------------------| | 1 | Invalid event | | 2 | Invalid event properties | | 3 | Unknown/empty service name | | 4 | MicroserviceCall Error |

Usage

'use strict';

const EventEmitter = require('@janiscommerce/event-emitter');

process.env.JANIS_SERVICE_NAME = 'my-service';

(async () => {

	try {
		const { result, response } = await EventEmitter.emit({
			entity: 'some-entity',
			event: 'some-event',
			client: 'some-client',
			id: 1
		});

		if(!result)
			console.log(response);

	} catch(err) {
		throw err;
	}

	try {
		const { result, response } = await EventEmitter.emit({
			entity: 'some-entity',
			event: 'some-event',
			client: 'some-client',
			id: [1, 2, 3, 4]
		});

		if(!result)
			console.log(response);

	} catch(err) {
		throw err;
	}

})();