Configuration.replaceMessage()
Description
Appends a replaceMessage filter to the current pipeline layout.
A replaceMessage filter calls back user scripts to get a replacement for each complete message (Message) found in the input stream.
- INPUT - Any types of Events.
- OUTPUT - Any types of Events.
The user function will receive as parameter a Message object that is removed from the input stream. Whatever the function returns will be inserted into the output stream in place of the removed events. 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.
A Message object is not an Event, but a convenient container for a series of Events that compose a complete message, that is, starting with a MessageStart event, followed by one or more Data events and ended by a MessageEnd event.
You can also use a fixed replacement value instead of a function if the replacement is static.
Syntax
pipy().pipeline().replaceMessage(message => transform(message))
Parameters
replaceMessage(handler?)
A callback function that receives Messages 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.