return

Return from execute or exit script.

Parameters

No specific parameters. Optional JSON parameter(s) of any type will be saved to return_value.

Variables

Set by the method:

• return_value:(out) Optional return value.

Examples

Return with optional value

YAML

version: 1.0.0
sections:
  main:
    - return: 1

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "return": 1
      }
    ]
  }
}

Return with multiple values

YAML

version: 1.0.0
sections:
  main:
    - execute: fn_that_returns
    - play: "say: returned %{return_value[0].a}"

  fn_that_returns:
    - return:
        - a: 1
        - b: 2

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "execute": "fn_that_returns"
      },
      {
        "play": "say: returned %{return_value[0].a}"
      }
    ],
    "fn_that_returns": [
      {
        "return": [
          {
            "a": 1
          },
          {
            "b": 2
          }
        ]
      }
    ]
  }
}

using the on_return parameter

YAML

version: 1.0.0
sections:
  main:
    - execute:
        dest: fn_that_returns
        on_return:
          - play: "say: returned %{return_value}"

  fn_that_returns:
    - return: "hello"

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      {
        "execute": {
          "dest": "fn_that_returns",
          "on_return": [
            {
              "play": "say: returned %{return_value}"
            }
          ]
        }
      }
    ],
    "fn_that_returns": [
      {
        "return": "hello"
      }
    ]
  }
}

Return with no value

YAML

version: 1.0.0
sections:
  main:
    - return

JSON

{
  "version": "1.0.0",
  "sections": {
    "main": [
      "return"
    ]
  }
}

Additional examples are available in the introduction.