nestjs-temporal-core
    Preparing search index...

    Interface UpdateDefinition<Ret, Args, Name>

    An interface representing a Workflow update definition, as returned from defineUpdate

    Args can be used for parameter type inference in handler functions and WorkflowHandle methods. Name can optionally be specified with a string literal type to preserve type-level knowledge of the update name.

    interface UpdateDefinition<
        Ret,
        Args extends any[] = [],
        Name extends string = string,
    > {
        "[argsBrand]": Args;
        "[retBrand]": Ret;
        name: Name;
        type: "update";
    }

    Type Parameters

    • Ret
    • Args extends any[] = []
    • Name extends string = string
    Index
    [argsBrand] [retBrand] name type
    "[argsBrand]": Args

    Virtual type brand to maintain a distinction between UpdateDefinition types with different args. This field is not present at run-time.

    "[retBrand]": Ret

    Virtual type brand to maintain a distinction between UpdateDefinition types with different return types. This field is not present at run-time.

    name: Name
    type: "update"

    Settings
    Member Visibility

    On This Page
    Properties