Interface ITaskMiddleware<TConfig, TEnforceInputContract, TEnforceOutputContract, TDependencies>

interface ITaskMiddleware<TConfig, TEnforceInputContract, TEnforceOutputContract, TDependencies> {
    __containsContract: true;
    [CONTRACT]: {
        config: TConfig;
        input: TEnforceInputContract;
        output: TEnforceOutputContract;
    };
    [symbolFilePath]: string;
    [symbolTaskMiddleware]: true;
    config: TConfig;
    configSchema?: IValidationSchema<TConfig>;
    dependencies: TDependencies | (() => TDependencies);
    everywhere?: boolean | ((task: ITask<any, any, any, any, TagType[], TaskMiddlewareAttachmentType[]>) => boolean);
    id: string;
    meta?: IMiddlewareMeta;
    run: ((input: ITaskMiddlewareExecutionInput<TEnforceInputContract extends void
        ? any
        : TEnforceInputContract, TEnforceOutputContract extends void
        ? any
        : TEnforceOutputContract>, dependencies: DependencyValuesType<TDependencies>, config: TConfig) => Promise<any>);
    tags: TagType[];
    with: ((config: TConfig) => ITaskMiddlewareConfigured<TConfig, TEnforceInputContract, TEnforceOutputContract, TDependencies>);
}

Type Parameters

  • TConfig = any
  • TEnforceInputContract = void
  • TEnforceOutputContract = void
  • TDependencies extends DependencyMapType = any

Hierarchy (view full)

Properties

__containsContract [CONTRACT] [symbolFilePath] [symbolTaskMiddleware] config configSchema? dependencies everywhere? id meta? run tags with

Properties

Readonly__containsContract

__containsContract: true

Readonly[CONTRACT]

[CONTRACT]: {
    config: TConfig;
    input: TEnforceInputContract;
    output: TEnforceOutputContract;
}

[symbolFilePath]

[symbolFilePath]: string

[symbolTaskMiddleware]

[symbolTaskMiddleware]: true

config

config: TConfig

Current configuration object (empty by default).

OptionalconfigSchema

configSchema?: IValidationSchema<TConfig>

Optional validation schema for runtime config validation. When provided, middleware config will be validated when .with() is called.

dependencies

dependencies: TDependencies | (() => TDependencies)

Static or lazy dependency map.

Optionaleverywhere

everywhere?: boolean | ((task: ITask<any, any, any, any, TagType[], TaskMiddlewareAttachmentType[]>) => boolean)

id

id: string

Optionalmeta

meta?: IMiddlewareMeta

run

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

The middleware body, called with task execution input.

tags

tags: TagType[]

with

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

Configure the middleware and return a marked, configured instance.

Settings

Member Visibility

On This Page

Properties