@servicenow/sdk - v4.4.1
    Preparing search index...

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

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

    The Subflow object (created by SubflowDefinition).

    Configuration object with $id and optional annotation.

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

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

    type Subflow<I, O> = {
        inputs: I;
        outputs: O;
        <TInputs extends { waitForCompletion?: boolean }>(
            id: string | ExplicitKey<string>,
            inputs: TInputs & I & { waitForCompletion?: boolean },
        ): O;
    }

    Type Parameters

    • I

      The type of the input parameters for the subflow.

    • O

      The type of the output parameters for the subflow.

    • Invokes the subflow.

      Type Parameters

      • TInputs extends { waitForCompletion?: boolean }

      Parameters

      • id: string | ExplicitKey<string>

        An identifier for this specific instance of the subflow.

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

        The input data for the subflow, conforming to the inferred input schema.

      Returns O

      The output data from the subflow, conforming to the inferred output schema.

    Index

    Properties

    Properties

    inputs: I

    The schema definition for the subflow's inputs.

    outputs: O

    The schema definition for the subflow's outputs.