/coconspirators

📞 Microservice framework for RabbitMQ written in TypeScript

Primary LanguageTypeScriptMIT LicenseMIT

coconspirators

Codacy Badge Codacy Badge Build Status npm version

⚠️ This library is no longer under active development ⚠️

Swimlane no longer uses this library in our codebase. That may change in the future, but for now it will no longer be maintained.

coconspirators is a microservice framework for RabbitMQ written in TypeScript. Under the hood it uses amqp.node, the battle-tested AMQP client, to communicate with RabbitMQ and has best-practices baked in. Features include:

  • Simple API for subscribing, publish and replying
  • DI Friendly
  • TypeScript First

Install

npm i coconspirators --S

Building

npm run build

Usage

import { Queue, AmqpQueue, AmqpClient  } from 'coconspirators';

export class AmqpServer {
  connection: Promise<any>;
  constructor(public client: AmqpClient, logger: Logger) {
    this.connection = this.client.connect();

    client.on('connected', () => console.log('connected!'));
    client.on('disconnected', () => console.log('disconnected!'));
  }
}

interface ZooMessage {
  animal: string;
}

@Queue({
  name: 'health'
  contentType: 'application/json'
})
export class HealthQueue extends AmqpQueue<ZooMessage> {
  constructor(client: AmqpClient) { super(client); }
}

export class HealthChecker {
  constructor(queue: HealthQueue) {
    this.queue.publish({ hi: true });
    this.queue.subscribe((message: ZooMessage) => {
      console.log('message', message);
    })
  }
}

Credits

coconspirators is a Swimlane open-source project; we believe in giving back to the open-source community by sharing some of the projects we build for our application. Swimlane is an automated cyber security operations and incident response platform that enables cyber security teams to leverage threat intelligence, speed up incident response and automate security operations.