nestjs-temporal-core
    Preparing search index...

    Type Alias WorkflowHandleWithMetadata<T>

    WorkflowHandleWithMetadata: WorkflowHandle<T> & { handle: WorkflowHandle<T> }

    Workflow handle with additional metadata, generic on the workflow function type T.

    When T is known (e.g. inside IWorkflowProxy<T>), result() returns Promise<WorkflowResultType<T>> and signal/query methods are fully typed. Defaults to the base Workflow type for untyped call sites (e.g. TemporalClientService).

    Type Parameters

    // orderWorkflow: (orderId: string, customerId: number) => Promise<{ status: string }>
    const handle = await this.orderProxy.start(['order-1', 42]);
    // handle.result() is Promise<{ status: string }> — no cast required
    const { status } = await handle.result();

    // Defaults to WorkflowHandleWithMetadata<Workflow>; result() is Promise<unknown>
    const handle = await clientService.startWorkflow('orderWorkflow', [orderId]);
    const raw = await handle.result(); // caller narrows

    Settings

    Member Visibility