https://github.com/swimlane/coconspirators

📞 Microservice framework for RabbitMQ written in TypeScript
https://github.com/swimlane/coconspirators

amqp messaging nodejs queue rabbitmq typescript

Last synced: 1 day ago
JSON representation

📞 Microservice framework for RabbitMQ written in TypeScript

• Host: GitHub
• URL: https://github.com/swimlane/coconspirators
• Owner: swimlane
• License: mit
• Archived: true
• Created: 2017-02-28T13:04:37.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-01-11T17:39:25.000Z (almost 6 years ago)
• Last Synced: 2024-10-14T06:50:12.354Z (21 days ago)
• Topics: amqp, messaging, nodejs, queue, rabbitmq, typescript
• Language: TypeScript
• Homepage:
• Size: 222 KB
• Stars: 43
• Watchers: 38
• Forks: 12
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# coconspirators

[![Codacy Badge](https://api.codacy.com/project/badge/Grade/0c04d1d742714daeb66c7a418850aa7d)](https://www.codacy.com/app/Swimlane/coconspirators?utm_source=github.com&utm_medium=referral&utm_content=swimlane/coconspirators&utm_campaign=Badge_Grade) [![Codacy Badge](https://api.codacy.com/project/badge/Coverage/0c04d1d742714daeb66c7a418850aa7d)](https://www.codacy.com/app/Swimlane/coconspirators?utm_source=github.com&utm_medium=referral&utm_content=swimlane/coconspirators&utm_campaign=Badge_Coverage) [![Build Status](https://travis-ci.org/swimlane/coconspirators.svg?branch=master)](https://travis-ci.org/swimlane/coconspirators) [![npm version](https://badge.fury.io/js/coconspirators.svg)](https://badge.fury.io/js/coconspirators)

# ⚠️ 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](https://github.com/squaremo/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

```typescript

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

export class AmqpServer {

  connection: Promise;

  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 {

  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](http://swimlane.com) 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.