Sign Up
Loading...

On this page

Return

The return command in Twidget is a special command used to halt the current command workflow and immediately return a specified result. This command overrides any subsequent processes and outputs the return result regardless of the rest of the workflow logic. This command is particularly useful for error handling, conditional exits, or when a certain result needs to be promptly returned.

Parameters

  • <result>: The value or object you want to return. This result can be a simple data type (e.g., text, number, boolean) or a complex object.

Usage

When the return command is executed, it:

  1. Stops the execution of the current workflow.

  2. Discards any further processing or commands that follow it in the workflow.

  3. Outputs the specified result as the final output of the workflow.

It is imperative to consider how the return command fits into your overall output schema since it will determine the structure and type of the final output.

Considerations

  • Output Schema: Ensure the output schema of your workflow accounts for the type of results that might be returned by the return command.

  • Workflow Design: Carefully design your workflows to use the return command appropriately for intended early exits or error handling mechanisms.

  • Command Placement: Place the return command where specific conditions are met to avoid unintended workflow terminations.

The return command is powerful for controlling the flow and output of workflows in Twidget. By understanding its behavior and correctly implementing it in your workflows, you can create more efficient and effective automation processes.

Related Topics

Error Handling

When building applications with Twidget, you may encounter situations where you need to handle errors gracefully to ensure your application runs smoothly. Twidget provides two powerful commands for error handling: `try-catch` and `throw-error`. This documentation will guide you on how to use these c...

Send Message

Send SMS Command. With Twidget, you can send SMS messages to phones using the `Send SMS` command. This functionality varies depending on the provider. Currently, we support Twilio as the SMS provider. To use Twilio for SMS integrations, you will need: - A Twilio account ID - Twilio Auth Token - A Tw...

Lists

Twidget offers a variety of commands to help you manipulate lists easily without coding. Below is a detailed explanation of each command available. Get. Description: Returns the element in the provided list at the given index. Inputs: - `list`: The list from which to get the element. - `index`: The ...

Conditionals

Condition Command. The Condition Command allows you to perform actions based on whether an expression evaluates to true or false. You can nest other commands within the true or false branches of the condition, enabling complex logic flows. - Expression Builder: Validate two variables to equal true. ...

Conversion

Overview. Twidget's conversion commands allow you to easily convert different data types to the required format. Below is a list of the available conversion commands and examples of how to use them. The `Convert to Text` command converts the provided value to a text (string) format. Examples: - `123...