rabbit-mermaid

0.4.1 • Public • Published

rabbit-mermaid NPM version Build Status Dependency Status Coverage percentage

Generate markdown flowcharts of your rabbitmq topology.

rabbit-mermaid takes your rabbitmq topology files and turns them into markdown flowcharts. Direct, fanout, and topic-based exchanges are supported.

Installation

$ npm install --save rabbit-mermaid

Usage

const { MermaidGenerator } = require("rabbit-mermaid");
const topology = require("./topology.json");
const mermaidGenerator = new MermaidGenerator(topology);
mermaidGenerator.generate();

Filtering

The exchanges option will let you specify exactly which exchanges should show up in the generated output. Please note that exchange to exchange bindings will be excluded if both exchanges are not specified. This is intentional to reduce noise in large topologies with many dependencies.

const mermaidGenerator = new MermaidGenerator(topology);
const opts = {
  exchanges: ["JPEG"]
};
mermaidGenerator.generate(opts);

License

MIT © David Salas

Dependencies (1)

Dev Dependencies (11)

Package Sidebar

Install

npm i rabbit-mermaid

Weekly Downloads

2

Version

0.4.1

License

MIT

Unpacked Size

32.1 kB

Total Files

13

Last publish

Collaborators

  • davidlivingrooms