Interface FlowConfig<I, O, S, Init>

Configuration for a streaming flow.

interface FlowConfig<
    I extends z.ZodTypeAny = z.ZodTypeAny,
    O extends z.ZodTypeAny = z.ZodTypeAny,
    S extends z.ZodTypeAny = z.ZodTypeAny,
    Init extends z.ZodTypeAny = z.ZodTypeAny,
> {
    initJsonSchema?: JSONSchema7;
    initSchema?: Init;
    inputSchema?: I;
    metadata?: Record<string, any>;
    name: string;
    outputSchema?: O;
    streamSchema?: S;
}

Type Parameters

I extends z.ZodTypeAny = z.ZodTypeAny
O extends z.ZodTypeAny = z.ZodTypeAny
S extends z.ZodTypeAny = z.ZodTypeAny
Init extends z.ZodTypeAny = z.ZodTypeAny

Index

Properties

initJsonSchema? initSchema? inputSchema? metadata? name outputSchema? streamSchema?

Properties

`Optional`initJsonSchema

initJsonSchema?: JSONSchema7

JSON schema of the initialization data.

`Optional`initSchema

initSchema?: Init

Schema of the initialization data.

`Optional`inputSchema

inputSchema?: I

Schema of the input to the flow.

`Optional`metadata

metadata?: Record<string, any>

Metadata of the flow used by tooling.

name

name: string

Name of the flow.

`Optional`outputSchema

outputSchema?: O

Schema of the output from the flow.

`Optional`streamSchema

streamSchema?: S

Schema of the streaming chunks from the flow.