torotask/dist/functions.d.ts

Task queue processing in NodeJS based on BullMQ and Redis

import { z } from 'zod';
import type { TaskDefinition, TaskGroupDefinition, TaskGroupDefinitionRegistry, SchemaHandler, TaskTrigger, SingleOrArray, ResolvedSchemaType, TaskDefinitionRegistry, TaskHandlerContext, EffectivePayloadType, TaskOptions, // Added TaskOptions for DefineTaskInputConfig
TaskHandler } from './types/index.js';
import type { StepExecutor } from './step-executor.js';
import type { TaskJob } from './job.js';
type DefineTaskInputConfig<PayloadExplicit, SchemaInput extends SchemaHandler | undefined, InferredHandlerResult> = {
    handler: TaskHandler<EffectivePayloadType<PayloadExplicit, ResolvedSchemaType<SchemaInput>>, InferredHandlerResult, // Key for inference
    ResolvedSchemaType<SchemaInput>>;
    options?: TaskOptions;
    schema?: SchemaInput;
    triggers?: SingleOrArray<TaskTrigger<EffectivePayloadType<PayloadExplicit, ResolvedSchemaType<SchemaInput>>>>;
    id?: string;
};
/**
 * Defines a task group configuration.
 * This function helps with type inference for task group definitions.
 *
 * @template TDefs The type of task definitions contained in this group.
 * @param name The name of the task group.
 * @param definitions The task definitions for this group.
 * @returns The task group definition object, correctly typed.
 */
export declare function defineTaskGroup<TTaskMap extends TaskDefinitionRegistry>(config: TaskGroupDefinition<TTaskMap>): TaskGroupDefinition<TTaskMap>;
/**
 * Defines a task group registry.
 * This function helps with type inference for task group definitions.
 *
 * @template T The specific type of the task group definitions registry.
 * @param groups The task group definitions.
 * @returns The task group definition registry, preserving its specific type.
 */
export declare function defineTaskGroupRegistry<T extends TaskGroupDefinitionRegistry>(groups: T): T;
/**
 * Defines a task configuration.
 * This function helps with type inference for the task definition.
 *
 * @template PayloadExplicit The type of the payload for the task. Defaults to `unknown`.
 *   If a `schema` is provided, this type is typically overridden by the schema's inferred type.
 * @template SchemaInput The type of the schema or schema function.
 * @template ResultExplicit The explicit type of the result returned by the task handler.
 *   If not provided (or set to `unknown`), the result type will be inferred from the handler.
 * @template InferredHandlerResult (Internal) The actual inferred result type from the handler.
 * @param config The task definition object.
 * @returns The task definition object, correctly typed.
 */
export declare function defineTask<PayloadExplicit = unknown, ResultExplicit = unknown, SchemaInput extends SchemaHandler | undefined = undefined, InferredHandlerResult = unknown>(config: DefineTaskInputConfig<PayloadExplicit, SchemaInput, InferredHandlerResult>): TaskDefinition<PayloadExplicit, ResultExplicit extends unknown ? InferredHandlerResult : ResultExplicit, SchemaInput>;
/**
 * Creates a schema directly from a function that receives the Zod builder.
 * This avoids needing to import `zod` in the consumer's file just for the type.
 *
 * @example
 * ```ts
 * const mySchema = createSchema(z => z.object({ id: z.string() }));
 * ```
 */
export declare function createSchema<T extends z.ZodTypeAny>(schemaFn: (zod: typeof z) => T): T;
/**
 * Retrieves the step executor from the task handler context.
 * This function is useful for accessing the step executor in a strongly typed manner.
 *
 * @template TAllTaskGroupsDefs The type of all task group definitions.
 * @template TActualPayload The actual payload type for the task.
 * @template TResult The result type for the task.
 * @param context The task handler context.
 * @returns The step executor, correctly typed.
 */
export declare function getTypedStep<TAllTaskGroupsDefs extends TaskGroupDefinitionRegistry, const TCurrentTaskGroup extends keyof TAllTaskGroupsDefs = never, TActualPayload = any, TResult = any>(context: TaskHandlerContext<TActualPayload, TResult>, _currentGroup?: TCurrentTaskGroup): StepExecutor<TaskJob<TActualPayload, TResult, any>, TAllTaskGroupsDefs, TCurrentTaskGroup>;
export {};
//# sourceMappingURL=functions.d.ts.map