ChildRunOptions

Hierarchy

• ChildRunOptions
  • CallOptions
  • StartOptions
  • CallTaskOptions
  • StartTaskOptions

Index

Properties

• abortWithParent
• runName

Properties

optionalabortWithParent

abortWithParent?: boolean = false

Gracefully abort the child run when this run is gracefully aborted. Requires runName.

The latest call under the same runName sets the value. Once this run is being aborted, a call with this option throws instead of starting, resurrecting or returning a run. A hard abort, timeout or crash of this run leaves the child run running.

A run started with a custom token is aborted with that token, except for a run started before a migration or resurrection of this run, which is aborted with the default client.

optionalrunName

runName?: string

Local name for the child run, unique across all Actors and tasks started by this run.

If a READY, RUNNING or SUCCEEDED run is already tracked under this name, it is returned instead of starting a new one, including after a migration or resurrection of this run. A run that was aborted or timed out is resurrected with the given options, once it finishes aborting or timing out. A run that failed is replaced by a new one. Reusing the name for a different Actor, task or input throws, unless the tracked run is replaced.