jwetzell/showbridge-docs
1
0
Fork 0
mirror of https://github.com/jwetzell/showbridge-docs.git synced 2026-09-11 15:09:27 +00:00
Code Issues Packages Projects Releases Wiki Activity

add notes about module interface implementations

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files
src/content/docs/processors/db/query.mdx
+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**:
src/content/docs/processors/kv/get.mdx
+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**:
src/content/docs/processors/kv/set.mdx
+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**:
src/content/docs/processors/pubsub/publish.mdx
+3 -1
View File
@@ -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**: