Skip to content

Commit 52cb747

Browse files
authored
Merge pull request serverlessworkflow#1050 from neuroglia-io/feat-document-async-task-output
Document the output of a task that defines an non-awaited process
2 parents 691ca1f + 80eea36 commit 52cb747

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

dsl-reference.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -717,13 +717,13 @@ Provides the capability to execute external [containers](#container-process), [s
717717

718718
##### Properties
719719

720-
| Name | Type | Required | Description|
720+
| Name | Type | Required | Description |
721721
|:--|:---:|:---:|:---|
722722
| run.container | [`container`](#container-process) | `no` | The definition of the container to run.<br>*Required if `script`, `shell` and `workflow` have not been set.* |
723723
| run.script | [`script`](#script-process) | `no` | The definition of the script to run.<br>*Required if `container`, `shell` and `workflow` have not been set.* |
724724
| run.shell | [`shell`](#shell-process) | `no` | The definition of the shell command to run.<br>*Required if `container`, `script` and `workflow` have not been set.* |
725725
| run.workflow | [`workflow`](#workflow-process) | `no` | The definition of the workflow to run.<br>*Required if `container`, `script` and `shell` have not been set.* |
726-
| await | `boolean` | `no` | Determines whether or not the process to run should be awaited for.<br>*Defaults to `true`.* |
726+
| await | `boolean` | `no` | Determines whether or not the process to run should be awaited for.<br>*When set to `false`, the task cannot wait for the process to complete and thus cannot output the process’s result. In this case, it should simply output its transformed input.*<br>*Defaults to `true`.* |
727727
| return | `string` | `no` | Configures the output of the process.<br>*Supported values are:*<br>*- `stdout`: Outputs the content of the process **STDOUT**.*<br>*- `stderr`: Outputs the content of the process **STDERR**.*<br>*- `code`: Outputs the process's **exit code**.*<br>*- `all`: Outputs the **exit code**, the **STDOUT** content and the **STDERR** content, wrapped into a new [processResult](#process-result) object.*<br>*- `none`: Does not output anything.*<br>*Defaults to `stdout`.* |
728728

729729
##### Examples

0 commit comments

Comments
 (0)