Interface MiddlewareTypeConfig<TSchema, TContextSchema, TFullContext, TTools>

Type bag that encapsulates all middleware type parameters.

This interface bundles all the generic type parameters used throughout the middleware system into a single configuration object. This pattern simplifies type signatures and makes it easier to add new type parameters without changing multiple function signatures.

Example

// Define a type configuration
type MyMiddlewareTypes = MiddlewareTypeConfig<
  typeof myStateSchema,
  typeof myContextSchema,
  MyContextType,
  typeof myTools
>;

interface MiddlewareTypeConfig<
    TSchema extends
        StateDefinitionInit
        | undefined = StateDefinitionInit | undefined,
    TContextSchema extends
        | BaseMessage
        | BaseMessage<BaseMessage>
        | BaseMessage<BaseMessage>
        | undefined =
        | BaseMessage
        | BaseMessage<BaseMessage>
        | BaseMessage<BaseMessage>
        | undefined,
    TFullContext = any,
    TTools extends
        readonly (BaseMessage | BaseMessage)[] = readonly (
        BaseMessage
        | BaseMessage
    )[],
> {
    ContextSchema: TContextSchema;
    FullContext: TFullContext;
    Schema: TSchema;
    Tools: TTools;
}

Type Parameters

TSchema extends StateDefinitionInit | undefined = StateDefinitionInit | undefined
The middleware state schema type. Can be a StateDefinitionInit (including InteropZodObject, StateSchema, or AnnotationRoot) or undefined.
TContextSchema extends BaseMessage | BaseMessage<BaseMessage> | BaseMessage<BaseMessage> | undefined = BaseMessage | BaseMessage<BaseMessage> | BaseMessage<BaseMessage> | undefined
The middleware context schema type. Can be an InteropZodObject, InteropZodDefault, InteropZodOptional, or undefined.
TFullContext = any
The full context type available to middleware hooks.
TTools extends readonly (BaseMessage | BaseMessage)[] = readonly (BaseMessage | BaseMessage)[]
The tools array type registered by the middleware.

Index

Properties

ContextSchema FullContext Schema Tools

Properties

ContextSchema

ContextSchema: TContextSchema

The middleware context schema type

FullContext

FullContext: TFullContext

The full context type

Schema

Schema: TSchema

The middleware state schema type

Tools

Tools: TTools

The tools array type

Interface MiddlewareTypeConfig<TSchema, TContextSchema, TFullContext, TTools>

Example

Type Parameters

Index

Properties

Properties

ContextSchema

FullContext

Schema

Tools

Settings

On This Page