@bluelibs/runner - v6.3.1
    Preparing search index...

    Interface ITaskMiddlewareConfigured<TConfig, TEnforceInputContract, TEnforceOutputContract, TDependencies, TTags>

    Configured task-middleware instance returned by .with(...).

    interface ITaskMiddlewareConfigured<
        TConfig = any,
        TEnforceInputContract = void,
        TEnforceOutputContract = void,
        TDependencies extends DependencyMapType = any,
        TTags extends TaskMiddlewareTagType[] = TaskMiddlewareTagType[],
    > {
        __containsContract: true;
        "[CONTRACT]": {
            config: ResolveMiddlewareConfigContract;
            input: TEnforceInputContract;
            output: TEnforceOutputContract;
        };
        "[symbolFilePath]": string;
        "[symbolMiddlewareConfigured]": true;
        "[symbolTaskMiddleware]": true;
        config: ResolveMiddlewareConfigContract<TConfig, TTags>;
        configSchema?: IValidationSchema<
            ResolveMiddlewareConfigContract<TConfig, TTags>,
        >;
        dependencies:
            | TDependencies
            | (
                (
                    config: ResolveMiddlewareConfigContract<TConfig, TTags>,
                ) => TDependencies
            );
        extract: (
            target: ITaskMiddleware<any, any, any, any, any>,
        ) => ResolveMiddlewareConfigContract<TConfig, TTags> | undefined;
        id: string;
        meta?: IMiddlewareMeta;
        path?: string;
        run: (
            input: ITaskMiddlewareExecutionInput<
                TEnforceInputContract extends void ? any : TEnforceInputContract,
                TEnforceOutputContract extends void ? any : TEnforceOutputContract,
            >,
            dependencies: DependencyValuesType<TDependencies>,
            config: ResolveMiddlewareConfigContract<TConfig, TTags>,
        ) => Promise<any>;
        tags: TTags;
        throws?: NormalizedThrowsList;
        with: (
            config: ResolveMiddlewareConfigContract<TConfig, TTags>,
        ) => ITaskMiddlewareConfigured<
            TConfig,
            TEnforceInputContract,
            TEnforceOutputContract,
            TDependencies,
            TTags,
        >;
    }

    Type Parameters

    Hierarchy (View Summary)

    Index

    Properties

    __containsContract [CONTRACT] [symbolFilePath] [symbolMiddlewareConfigured] [symbolTaskMiddleware] config configSchema? dependencies extract id meta? path? run tags throws? with

    Properties

    Readonly__containsContract

    __containsContract: true
    "[CONTRACT]": {
        config: ResolveMiddlewareConfigContract;
        input: TEnforceInputContract;
        output: TEnforceOutputContract;
    }
    "[symbolFilePath]": string
    "[symbolMiddlewareConfigured]": true
    "[symbolTaskMiddleware]": true
    config: ResolveMiddlewareConfigContract<TConfig, TTags>

    Current configuration object (empty by default).

    configSchema?: IValidationSchema<
        ResolveMiddlewareConfigContract<TConfig, TTags>,
    >

    Normalized validation schema for middleware config.

    dependencies:
        | TDependencies
        | (
            (
                config: ResolveMiddlewareConfigContract<TConfig, TTags>,
            ) => TDependencies
        )

    Normalized dependency declaration.

    extract: (
        target: ITaskMiddleware<any, any, any, any, any>,
    ) => ResolveMiddlewareConfigContract<TConfig, TTags> | undefined

    Extract the configured payload from a matching middleware entry.

    id: string

    Stable middleware identifier.

    meta?: IMiddlewareMeta

    Optional metadata used by docs and tooling.

    path?: string
    run: (
        input: ITaskMiddlewareExecutionInput<
            TEnforceInputContract extends void ? any : TEnforceInputContract,
            TEnforceOutputContract extends void ? any : TEnforceOutputContract,
        >,
        dependencies: DependencyValuesType<TDependencies>,
        config: ResolveMiddlewareConfigContract<TConfig, TTags>,
    ) => Promise<any>

    The middleware body, called with task execution input.

    tags: TTags

    Normalized tags attached to the middleware.

    throws?: NormalizedThrowsList

    Normalized list of error ids declared via throws.

    with: (
        config: ResolveMiddlewareConfigContract<TConfig, TTags>,
    ) => ITaskMiddlewareConfigured<
        TConfig,
        TEnforceInputContract,
        TEnforceOutputContract,
        TDependencies,
        TTags,
    >

    Configure the middleware and return a marked, configured instance.

    Settings

    Member Visibility

    On This Page

    Properties