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

Advanced file commands

Prepare CSV downloads, work with small ZIP archives and share a temporary download link from an endpoint, server function or event. Find these commands under File Manager when adding a command. Use the usual variable selector and Return as field. The existing file commands still handle storage, fold...

Realtime commands

Use these commands in endpoints, server functions and events to connect authenticated customers and send live notifications. Start with [Realtime channels](/docs/builder/realtime) to create a channel and choose its audience. Authorize Realtime. Issue a one-use connection ticket for the signed-in cus...

AI connectors

For every command’s inputs, results, examples and common errors, open the [detailed connector reference](/docs/connectors/overview). The command editor’s help button opens its exact reference section. Use an AI provider from an endpoint, server function or event. Choose your organization's connector...

Database

Twidget offers many commands to manage data in your database. Below is a list of the available commands and their functionalities: Get Data. Retrieve an entry from a table. Get Multiple Data. Retrieve multiple entries from a table. Save Data. Save an object to a database table. Save Multiple Data. S...

Session Storage

Twidget includes a suite of session storage commands that enable no-code interaction with the browser’s `sessionStorage` API. These tools allow temporary storage of key-value data for the current page session. Purpose. Session storage commands allow developers to manage transient data tied to a sing...