Micro Fleet - Backend Service Communication library

Belongs to Micro Fleet framework, provides methods for microservices to communicate with each other.

See more examples and usage guide in unit tests.

INSTALLATION

• Stable version: npm i @micro-fleet/service-communication
• Edge (development) version: npm i git://github.com/gennovative/micro-fleet-service-communication.git

DEVELOPMENT

• Install packages in peerDependencies section with command npm i --no-save {package name}@{version}. Or if you want to use directly neighbor packages, excute npm run linkPackages.
• npm run build to transpile TypeScript then run unit tests (if any) (equiv. npm run compile + npm run test (if any)).
• npm run compile: To transpile TypeScript into JavaScript.
• npm run watch: To transpile without running unit tests, then watch for changes in *.ts files and re-transpile on save.
• npm run test: To run unit tests.

  • One of the quickest way to set up the test environment is to use Docker:

    docker run -d --name rabbitmq -p 15672:15672 -p 5672:5672 rabbitmq:3.6-management-alpine

  • After tests finish, open file /coverage/index.html with a web browser to see the code coverage report which is mapped to TypeScript code.

RELEASE

• npm run release: To transpile and create app.d.ts definition file.
• Note: Please commit transpiled code in folder dist and definition file app.d.ts relevant to the TypeScript version.