Documentation
    Preparing search index...

    Type Alias IngressWorkflowClient<M>

    IngressWorkflowClient: Omit<
        {
            [K in keyof M as M[K] extends never ? never : K]: M[K] extends (
                arg: any,
                ...args: infer P,
            ) => PromiseLike<infer O>
                ? (
                    ...args: [...P, ...[opts?: Opts<InferArgType<(...)>, O>]],
                ) => PromiseLike<O>
                : never
        } & {
            workflowAttach: M extends Record<string, unknown>
                ? M["run"] extends (...args: any) => Promise<infer O>
                    ? (opts?: Opts<void, O>) => Promise<O>
                    : never
                : never;
            workflowOutput: M extends Record<string, unknown>
                ? M["run"] extends (...args: any) => Promise<infer O>
                    ? (opts?: Opts<void, O>) => Promise<Output<O>>
                    : never
                : never;
            workflowSubmit: M extends Record<string, unknown>
                ? M["run"] extends (arg: any, ...args: infer I) => Promise<infer O>
                    ? (
                        ...args: [...I, ...[opts?: SendOpts<(...)>]],
                    ) => Promise<WorkflowSubmission<O>>
                    : never
                : never;
        },
        "run",
    >

    A client for a workflow.

    This client represents the workflow definition, with the following additional methods:

    • workflowSubmit to submit the workflow.
    • workflowAttach to attach to the workflow and wait for its completion
    • workflowOutput to check if the workflow's output is ready/available.

    Once a workflow is submitted, it can be attached to, and the output can be retrieved.

    Type Parameters

    • M

      the type of the workflow.