mirror of
https://github.com/jwetzell/showbridge-docs.git
synced 2026-08-07 14:43:38 +00:00
work on auto-generating parts of docs from JSONSchema
This commit is contained in:
@@ -4,12 +4,11 @@ sidebar:
|
||||
label: Create
|
||||
order: 3
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `string.create` processor creates a string based on the provided template. This processor will return an error if there is an issue executing the template. The template property is just a [Go template](https://pkg.go.dev/text/template) that will be evaluated with the incoming message provided as an environment.
|
||||
|
||||
- **type**: `string.create`
|
||||
- **params**:
|
||||
- **template**: string template that will have the incoming message as the context
|
||||
<SchemaInfo type="processor" id="string.create"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,10 +4,11 @@ sidebar:
|
||||
label: Decode
|
||||
order: 1
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `string.decode` processor takes a array of bytes and turn it into string. This processor will return an error if the message being processed is not an array of bytes.
|
||||
|
||||
- **type**: `string.decode`
|
||||
<SchemaInfo type="processor" id="string.decode"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,10 +4,11 @@ sidebar:
|
||||
label: Encode
|
||||
order: 2
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `string.encode` 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.encode`
|
||||
<SchemaInfo type="processor" id="string.encode"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
@@ -4,12 +4,11 @@ sidebar:
|
||||
label: Split
|
||||
order: 5
|
||||
---
|
||||
import SchemaInfo from '../../../../components/SchemaInfo.astro';
|
||||
|
||||
The `string.split` processor takes a string and turns it into an array of strings by splitting on `params.separator`. This processor will return an error if the message being processed is not a string.
|
||||
|
||||
- **type**: `string.split`
|
||||
- **params**:
|
||||
- **pattern**: string to split incoming string on
|
||||
<SchemaInfo type="processor" id="string.split"/>
|
||||
|
||||
### Example
|
||||
|
||||
|
||||
Reference in New Issue
Block a user