Configuration.replaceMessageStart()
Description
Appends a replaceMessageStart filter to the current pipeline layout.
A replaceMessageStart filter calls back user scripts to get a replacement for each MessageStart event found in the input stream.
- INPUT - Any types of Events.
- OUTPUT - Any types of Events.
The user function will receive as parameter a MessageStart event that is removed from the input stream. Whatever the function returns will be inserted into the output stream in place of the removed event. It can be an event or a Message, or an array of events or Messages. If the function returns nothing (null or undefined), no events will be inserted back into the stream.
You can also use a fixed replacement value instead of a function if the replacement is static.
Syntax
pipy().pipeline().replaceMessageStart(event => transform(event))
Parameters
replaceMessageStart(handler?)
A callback function that receives MessageStart events passing through the filter and returns their replacements. The replacement can be an Event, a Message or an array of them.
The same Configuration object.