add notes about module interface implementations

This commit is contained in:
Joel Wetzell
2026-05-19 22:27:46 -05:00
parent 4a873a32d4
commit e10ae19992
8 changed files with 16 additions and 3 deletions
+2
View File
@@ -10,6 +10,8 @@ The `db.sqlite` module can open/create SQLite databases
- **params**:
- **dsn**: the data source name, this can be a file path or the special `:memory:` name for an in-memory DB
This module implements the `DatabaseModule` interface.
## Cap
### Example snippet
+2
View File
@@ -13,6 +13,8 @@ The `mqtt.client` module connects to a MQTT broker and emits a message messages
- **topic** mqtt topic to subscribe to
- **clientId** client ID for this connection to the broker
This module implements the `PubSubModule` interface.
### Example
Open a mqtt connection to `test.mosquitto.org` subscribing to the `showbridge` topic.
+2
View File
@@ -12,6 +12,8 @@ This module connects to a [NATS](https://nats.io/) server and subscribes to a su
- **url**: the URL of the NATS server to connect to (e.g. `nats://localhost:4222`)
- **subject**: the subject to subscribe to
This module implements the `PubSubModule` interface.
### Example
Connect to a local NATS server and subscribe to the `events` subject
@@ -12,6 +12,8 @@ The `redis.client` module connects to a Redis server. This module does not produ
- **host**: the Redis server host
- **port**: the Redis server port
This module implements the `KeyValueModule` interface.
### Example
Connect to a Redis server running on `localhost` at port `6379`.
+2
View File
@@ -6,6 +6,8 @@ sidebar:
---
The `db.query` processor will issue a query to the specified module and return the result to the next processor in line.
The module must implement the `DatabaseModule` interface for this processor to work.
This processor will return an error if any of the required parameters are missing/invalid or if the module does not implement the `DatabaseModule` interface.
- **type**: `db.query`
- **params**:
+2 -1
View File
@@ -5,7 +5,8 @@ sidebar:
order: 1
---
The `kv.get` processor gets the value associated with a key from a compatible module. The output payload is the value if the key is found.
The `kv.get` processor gets the value associated with a key from a module that implements the `KeyValueModule` interface.
The output payload is the value if the key is found.
- **type**: `kv.get`
- **params**:
+1 -1
View File
@@ -5,7 +5,7 @@ sidebar:
order: 2
---
The `kv.set` processor sets the value associated with a key from a compatible module. The payload is unchanged so whatever is received by this payload is output unless any errors are encountered.
The `kv.set` processor sets the value associated with a key from a module that implements the `KeyValueModule` interface. The payload is unchanged so whatever is received by this payload is output unless any errors are encountered.
- **type**: `kv.set`
- **params**:
@@ -5,7 +5,9 @@ sidebar:
order: 1
---
This processor will publish the incoming payload to a Pub/Sub capable module. This processor will return an error if any of the required parameters are missing or if the parameters are of the wrong type.
This processor will publish the incoming payload to a module that implements the `PubSubModule` interface.
This processor will return an error if any of the required parameters are missing or if the parameters are of the wrong type.
The payload is unchanged so whatever is received by this payload is output unless any errors are encountered.
- **type**: `pubsub.publish`
- **params**: