Skip to main content

ERROR signal

Emits ERROR signal.

component image

In-ports

trigger <any> — triggers ERROR signal.

config <any> (dynamic) — accepts a JSON object with configuration properties that can be set at runtime.

Out-ports

output <Signal> — emits ERROR signal event.

Overview

The ERROR signal component is designed to indicate an error condition or exception by transmitting an error message. It immediately emits an ERROR signal on the output port after initialization. When the trigger port is utilized, the component waits for an incoming event before emitting the ERROR signal. The component also responds to events on the config port, emitting an ERROR signal each time.

Developers can utilize this component to signal exceptions within their applications, sending custom error messages to other components or widgets. This is particularly useful for components that need to broadcast internal exceptions, such as an HTTP component emitting an ERROR signal due to an external service failure.

Settings

Enable realtime config port

When enabled, this setting allows the component to be configured via the config port. The port accepts a configuration object as input, enabling dynamic property updates during runtime. While using this port won't trigger component reinitialization, it may result in the loss of some previous component state.

Message (message)

Error message to be transmitted along with the signal.

Type: String
Required: No
Default: