Skip to main content

ERROR signal

Emits ERROR signal.

component image

In-ports

trigger <any> (dynamic) — 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 is used to indicate an error condition or exception and to transmit an error message. It emits an ERROR signal on the output port immediately after its initialization. If the trigger port is connected, the component will wait for an event on the trigger port before emitting the signal. The component emits an ERROR signal each time it receives an event on the trigger or config port.

You can use this component to signal an exception in your app and send a custom error message to widgets or components. Some components emit ERROR signals to indicate their internal exceptions. For example, an HTTP component emits an ERROR signal when an exception occurs in the external service.

Configuration

This component supports dynamic configuration. You can specify the required settings either in settings dialog or through a configuration object. To enable the config port for runtime configuration, set the “Enable realtime config port” option in settings.

Settings

Enable realtime config port

If this setting is enabled, the component can be configured through the config port. This port accepts a configuration object as input and allows you to set dynamic properties at runtime. Note that using this port does not cause the component to reinitialize, but it may cause some previous state of the component to be lost.

Message (message)

Error message to be transmitted along with the signal.

Type: String
Required: No
Default: