Interface Flow<I, O, S>

Flow is an observable, streamable, (optionally) strongly typed function.

interface Flow<
    I extends ZodTypeAny = ZodTypeAny,
    O extends ZodTypeAny = ZodTypeAny,
    S extends ZodTypeAny = ZodTypeAny,
> {
    __action: ActionMetadata<I, O, S>;
    __registry: Registry;
    run(
        input: TypeOf<I>,
        options?: ActionRunOptions<TypeOf<S>>,
    ): Promise<ActionResult<TypeOf<O>>>;
    stream(
        input?: TypeOf<I>,
        opts?: ActionRunOptions<TypeOf<S>>,
    ): StreamingResponse<O, S>;
    (input?: TypeOf<I>, options?: ActionRunOptions<S>): Promise<TypeOf<O>>;
}

Type Parameters

Hierarchy (View Summary)

  • Flow(input?: TypeOf<I>, options?: ActionRunOptions<S>): Promise<TypeOf<O>>

  • Parameters

    • Optionalinput: TypeOf<I>
    • Optionaloptions: ActionRunOptions<S>

    Returns Promise<TypeOf<O>>

Properties

__action __registry

Methods

run stream

Properties

__action

__action: ActionMetadata<I, O, S>

__registry

__registry: Registry

Methods

run

  • run(
        input: TypeOf<I>,
        options?: ActionRunOptions<TypeOf<S>>,
    ): Promise<ActionResult<TypeOf<O>>>

  • Parameters

    Returns Promise<ActionResult<TypeOf<O>>>

stream

Settings

Member Visibility

On This Page

Properties
Methods