ir-restifier v0.1.0-alpha.0

Instant Relay Receiver Node - Restifier

An Instant Relay Receiver Node that exposes received messages via a RESTful API (backed by fastify). It accepts messages with a topic and creates GET endpoints for each one of those topics. The last received message is provided as response of the relative GET endpoint.

Requirements

Node.js v14 LTS (14.15.1) or later.

Install

⚠️ Not published to npm yet

by using npm:

$ npm install ir-restifier

by using yarn:

$ yarn add ir-restifier

Usage

Look at test/base.spec.js for usage example. It's important to highlight that this module handles incoming messages which payload has the following shape:

{
  topic: "a-topic",
  payload: "the content, can be a complex object"
}

Contributing

Contributions are very welcome and wanted.

To submit your custom hook, please make sure your read our CONTRIBUTING guidelines.

Before submitting a new merge request, please make sure:

1. You have updated the package.json version and reported your changes into the CHANGELOG file
2. make sure you run npm test and npm build before submitting your merge request.

Credits

This library is provided and sponsored by:

As part of our commitment to support and contribute to the open source community.

License

Licensed under MIT.