A messaging service enabling secure, reactive communication between microservices.
Go to file
2024-04-01 21:41:43 +02:00
.gitea/workflows fix(core): update 2023-07-25 11:33:13 +02:00
.vscode fix(core): update 2023-07-25 11:33:13 +02:00
test fix(core): update 2023-07-25 11:33:13 +02:00
ts fix(core): update 2023-07-25 11:40:11 +02:00
.gitignore fix(core): update 2020-09-24 18:17:52 +00:00
license fix(core): update 2019-04-11 16:53:28 +02:00
npmextra.json update tsconfig 2024-04-01 21:41:43 +02:00
package.json 1.0.108 2023-07-25 11:40:12 +02:00
pnpm-lock.yaml fix(core): update 2023-07-25 11:33:13 +02:00
readme.md fix(core): update 2023-07-25 11:33:13 +02:00
tsconfig.json update tsconfig 2024-04-01 21:41:43 +02:00

@push.rocks/smartuniverse

messaging service for micro services

Status for master

Status Category Status Badge
GitLab Pipelines pipeline status
GitLab Pipline Test Coverage coverage report
npm npm downloads per month
Snyk Known Vulnerabilities
TypeScript Support TypeScript
node Support node
Code Style Code Style
PackagePhobia (total standalone install weight) PackagePhobia
PackagePhobia (package size on registry) PackagePhobia
BundlePhobia (total size when bundled) BundlePhobia

Usage

Use TypeScript for best in class instellisense.

What is smartuniverse all about?

Think WhatsApp, but for your microservices architecture. It allows your services to securely talk to each other in private, shielded channels without having to expose anything to the outside world. This allows the use of reactive programming across your entire stack.

Server side

every universe has a server that manages messages.
Think Kafka, but without Kafka.

import * as smartuniverse from '@pushrocks/smartuniverse';

const myUniverse = new smartuniverse.Universe({
  messageExpiryInMilliseconds: 60000, // the standard time in milliseconds until a message expires
});

// create as many channels as you like
myUniverse.addChannel('awesomeChannel', 'awesomeChannelPass');
myUniverse.addChannel('awesomeChannel2', 'jhkjhfsdf87eerkjslkfja9');

myUniverse.start(8765); // start the server and provide the port on which to listen on

Client side

All your microservices represents clients in the universe that may talk to each other using the universe server.

Contribution

We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can contribute one time or contribute monthly. :)

For further information read the linked docs at the top of this readme.

MIT licensed | © Task Venture Capital GmbH | By using this npm module you agree to our privacy policy