npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@sladdky/ah-mqttrouter

v0.0.3

Published

MQTT router for mqttjs/mqtt library.

Downloads

2

Readme

AH-MQTTROUTER

Naive implementation of MqttRouter for MQTT.js library. Route handling similar to Express's router.

Table of contents

Instalation

npm install @sladdky/ah-mqttrouter --save

Usage

import { connect } from 'mqtt';
import { MqttRouter } from '@sladdky/ah-mqttrouter'

const onMyMqttTopic1 = (request, response, next) => {
  //...your route logic
}
const onMyMqttTopic2 = (request, response, next) => {
  //...your route logic
}

const mqttClient = connect(<mqtt://url>);
const mqttRouter = new MqttRouter(mqttClient, {
  routes: [
    {topic: 'my-mqtt-topic-1', callback: [onMyMqttTopic1]},
    {topic: 'my-mqtt-topic-2', callback: [onMyMqttTopic2]},
  ]
});

API

  • mqttRouter.subscribe(topic: string, callback: MqttRouteCallback | MqttRouteCallback[])
  • mqttRouter.unsubscribe(topic: string, callback: MqttRouteCallback | MqttRouteCallback[])
  • mqttRouter.publish(topic: string, message: string | Buffer, opts?: IClientPublishOptions, callback?: PacketCallback | undefined): MqttClient;

MqttRouteCallback (Fire-and-Forget)

That's MQTT primary usage. One MqttClient sends a message to certain topic and other MqttClients that are subscribed to that topic, receive the message. No strings attached, no response expected.

  1. mqtt message fired from some client:
topic: "my-mqtt-topic"
message: "This is my message."
  1. example route implementation:
const onMyMqttTopic = (request, response, next) => {
  const { topic, payload } = request

  saveToDB(`topic: ${topic}, payload: ${payload}`)

  response.send('Message received and I saved it to the database')
}

MqttRouteCallback (Request-Response)

If you need request-response type of communication it's possible. The message is always expected to be stringified JSON.

  1. JSON must be in this form:
{
  responseTopic: "random-topic-the-requester-must-subscribe-before-sending",
  message: "This is my message"
}
  1. mqtt message sent will look like this
topic: "my-mqtt-topic"
message: '{"responseTopic":"random-topic-the-requester-must-subscribe-before-sending","message":"This is my message"}'
  1. example route implementation:
const onMyMqttTopic = (request, response, next) => {
  const { topic, payload } = request

  saveToDB(`topic: ${topic}, payload: ${payload}`)
}

The MQTTclient that is requesting has to subscribe to 'responseTopic' and unsubscribe after the response comes back. You can either handle this situation youself or use asynchronous mqttRequestor.

Example:

...
import { createMqttRequestor } from '@sladdky/ah-mqttrouter/lib/utils'

const mqttRouter = new MqttRouter(mqttClient)
const mqttRequestor = createMqttRequestor(mqttRouter)
mqttRequestor.send('my-mqtt-topic', 'This is my message').then((response) => {
  console.log(response.payload)
})

Middleware (workaround)

Please add your middleware logic as a route callback.

Example:

const onAuthMiddleware = (request, response, next) => {
  if (!isLoggedIn) {
    //...not-allowed to proccess
  }

  next()
}
const onMyMqttTopic = (request, response) => {
  //...your route logic
}

mqttRouter.subscribe('my-mqtt-topic', [onAuthMiddleware, onMyMqttTopic])

Re-routing

Not implemented.

based on ts-npm-package-boilerplate