RabbitMQ client for the stream protocol for Node.JS

NOT READY FOR PRODUCTION - The client is HEAVILY work in progress.

Table of Contents

• Overview
• Installing via NPM
• Getting started
  • Usage
    • Connect
• Build from source
• Project Status
• Release Process

Getting started

A rapid getting started

const rabbit = require("rabbitmq-stream-js-client")

async function main() {
  const connection = await rabbit.connect({
    hostname: "localhost",
    port: 5552,
    username: "rabbit",
    password: "rabbit",
    vhost: "/",
  })

  await connection.close()
}

main()
  .then(() => console.log("done!"))
  .catch((res) => console.log("ERROR ", res))

Usage

Connect

const connection = await connect({
  hostname: "localhost",
  port: 5552,
  username: "rabbit",
  password: "rabbit",
  vhost: "/",
})

// ...

await connection.close()

Build from source

Build:

$ npm run build

Test:

$ docker-compose up -d
$ npm run test

Check everything:

$ npm run check

Project Status

The client is HEAVILY work in progress. The API(s) could change prior to version 1.0.0

MISC

https://github.com/rabbitmq/rabbitmq-server/blob/master/deps/rabbitmq_stream/docs/PROTOCOL.adoc