Variable Subflow

Type Declaration

• • <I, O, TInputs extends { waitForCompletion?: boolean }>(
        _subflow: Subflow<I, O>,
        _config: SubflowInstanceConfig,
        _inputs: TInputs & I & { waitForCompletion?: boolean },
    ): O & { type: "subflow" }

  • Subflow instance with known Subflow definition - provides type-safe output property access

    Type Parameters

    • I

      The type of the input parameters for the subflow.

    • O

      The type of the output parameters for the subflow.

    • TInputs extends { waitForCompletion?: boolean }

      The actual input type being passed, which must be assignable to RuntimeInputs.

    Parameters

    • _subflow: Subflow<I, O>

      The Subflow object (created by SubflowDefinition).

    • _config: SubflowInstanceConfig

      Configuration object with $id and optional annotation.

    • _inputs: TInputs & I & { waitForCompletion?: boolean }

      The input data provided to the subflow, including optional waitForCompletion.

    Returns O & { type: "subflow" }

    The expected output of the subflow, typed as O with known properties.

  • (
        _subflow: string,
        _config: SubflowInstanceConfig,
        _inputs: RuntimeInputs<Record<string, any>>,
    ): any

  • Subflow instance with sys_id fallback - allows arbitrary property access for datapill references

    Parameters

    • _subflow: string

      A string sys_id when the subflow definition cannot be resolved.

    • _config: SubflowInstanceConfig

      Configuration object with $id and optional annotation.

    • _inputs: RuntimeInputs<Record<string, any>>

      The input data provided to the subflow (untyped).

    Returns any

    An object with arbitrary property access to support datapill references.