add documentation for filter.regex

This commit is contained in:
Joel Wetzell
2026-03-08 17:24:01 -05:00
parent 5ea1dde4ae
commit 27f36ce197
3 changed files with 23 additions and 18 deletions
+5
View File
@@ -70,6 +70,11 @@ export default defineConfig({
collapsed: true,
autogenerate: { directory: 'processors/router' }
},
{
label: "Filter",
collapsed: true,
autogenerate: { directory: 'processors/filter' }
},
{
label: "Int",
collapsed: true,
@@ -0,0 +1,18 @@
---
title: Regex Filter
sidebar:
order: 1
---
The `filter.regex` processor matches incoming string payload against a regular expression. If there is a match then the payload is sent through. This processor will return an error if the message being processed is not a string.
- **type**: `filter.regex`
- **params**:
- **pattern**: regex pattern to match against the incoming string
### Example
Match strings starting with `hello`
```
- type: filter.regex
params:
pattern: "^hello.*"
```
@@ -1,18 +0,0 @@
---
title: String Filter
sidebar:
order: 4
---
The `string.filter` processor takes a string and turns it into an array of bytes. This processor will return an error if the message being processed is not a string.
- **type**: `string.filter`
- **params**:
- **pattern**: regex pattern to match against the incoming string
### Example
Match strings starting with `hello`
```
- type: string.filter
params:
pattern: "^hello.*"
```