backup/showbridge-docs
1
0
Fork 0
mirror of https://github.com/jwetzell/showbridge-docs.git synced 2026-05-14 05:24:21 +00:00
Code Issues Packages Projects Releases Wiki Activity

update docs for route changes

Browse Source
This commit is contained in:
Joel Wetzell
2026-03-04 21:50:01 -06:00
parent 02522a52b5
commit 44a60b0d1a
10 changed files with 67 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/content/docs/concepts/routes.md
+3 -4
View File
@@ -4,11 +4,10 @@ sidebar:
order: 3
---
Routes take the messages coming from a module and push them out another module. The message can be optionally "processed" with any number of processor steps.
Routes take the messages coming from a module and push them through a list of [processors](/concepts/processors). Having no processors is valid but serves no real purpose and is basically a no-op.
## YAML Definition
- **input**: the id of the [module](/concepts/modules) that will provide messages to this route
- **processors**: (optional) array of [processors](/concepts/processors) that will be called in order and the result of the previous will be fed to the next processor.
- if at any point the output of a processor is `nil` the entire route will be terminated (subject to change to support output `nil` values?)
- an error in a processor step will also result in the route being terminated
- **output**: the id of the [module](/concepts/modules) that will consume messages from the route
- if at any point the output of a processor is `nil` the entire route will be terminated (subject to change to support passing through `nil` values?)
- an error in a processor step will result in the individual route being terminated