torotask/dist/types/task.d.ts

Task queue processing in NodeJS based on BullMQ and Redis

import type { StringValue } from 'ms';
import type { Logger } from 'pino';
import { type ZodSchema } from 'zod';
import type { ToroTask } from '../client.js';
import type { TaskJob } from '../job.js';
import type { TaskQueue } from '../queue.js';
import type { StepExecutor } from '../step-executor.js';
import type { TaskGroup } from '../task-group.js';
import type { Task } from '../task.js';
import type { TaskJobOptions } from './job.js';
import type { TaskQueueOptions } from './queue.js';
import type { EffectivePayloadType, ResolvedSchemaType, SchemaHandler } from './schema.js';
import type { Prettify, SingleOrArray } from './utils.js';
import type { TaskWorkerOptions } from './worker.js';
export type TaskTriggerCronValue = string;
export type TaskTriggerEveryValue = StringValue | number;
/**
 * Options for defining a Task, extending BullMQ's JobsOptions.
 */
export type TaskOptions = Prettify<TaskJobOptions & {
    allowCatchAll?: boolean;
    batch?: TaskWorkerOptions['batch'];
    workerOptions?: Partial<Omit<TaskWorkerOptions, 'batch'>>;
    queueOptions?: Partial<TaskQueueOptions>;
    skipSchemaValidation?: boolean;
}>;
/** Handler details passed to the task handler */
export interface TaskHandlerOptions<PayloadType = unknown> {
    id?: string;
    name: string;
    payload: PayloadType;
}
export interface BaseHandlerContext<PayloadType = unknown, ResultType = unknown> {
    logger: Logger;
    client: ToroTask;
    group: TaskGroup;
    queue: TaskQueue<PayloadType, ResultType>;
}
/** Context passed to the task handler */
export interface TaskHandlerContext<PayloadType = unknown, ResultType = unknown, _CurrentResolvedSchema extends ZodSchema | undefined = undefined> extends BaseHandlerContext<PayloadType, ResultType> {
    task: Task<PayloadType, ResultType, any>;
    job: TaskJob<PayloadType, ResultType>;
    step: StepExecutor<TaskJob<PayloadType, ResultType>>;
    token?: string | undefined;
}
/** Task handler function type */
export type TaskHandler<PayloadType = unknown, ResultType = unknown, CurrentResolvedSchema extends ZodSchema | undefined = undefined> = (options: TaskHandlerOptions<PayloadType>, context: TaskHandlerContext<PayloadType, ResultType, CurrentResolvedSchema>) => Promise<ResultType>;
export interface TaskTriggerBase<PayloadType = unknown> {
    payload?: PayloadType;
}
export interface TaskTriggerEvent<PayloadType = unknown> extends TaskTriggerBase<PayloadType> {
    type: 'event';
    event?: string;
    if?: string;
}
export interface TaskTriggerCron<PayloadType = unknown> extends TaskTriggerBase<PayloadType> {
    type: 'cron';
    name?: string;
    cron?: TaskTriggerCronValue;
}
export interface TaskTriggerEvery<PayloadType = unknown> extends TaskTriggerBase<PayloadType> {
    type: 'every';
    name?: string;
    every?: TaskTriggerEveryValue;
}
export type TaskTrigger<PayloadType = unknown> = TaskTriggerEvent<PayloadType> | TaskTriggerCron<PayloadType> | TaskTriggerEvery<PayloadType>;
export interface TaskConfig<PayloadExplicit = unknown, ResultType = unknown, SchemaInputValue extends SchemaHandler = undefined> {
    handler: TaskHandler<EffectivePayloadType<PayloadExplicit, ResolvedSchemaType<SchemaInputValue>>, ResultType, ResolvedSchemaType<SchemaInputValue>>;
    options?: TaskOptions;
    schema?: SchemaInputValue;
    triggers?: SingleOrArray<TaskTrigger<EffectivePayloadType<PayloadExplicit, ResolvedSchemaType<SchemaInputValue>>>>;
}
export interface TaskDefinition<PayloadExplicit = unknown, ResultType = unknown, SchemaInputValue extends SchemaHandler = undefined> extends TaskConfig<PayloadExplicit, ResultType, SchemaInputValue> {
}
export interface TaskDefinitionRegistry {
    [taskName: string]: TaskDefinition<any, any, any>;
}
export type TaskRegistry<TDefs extends TaskDefinitionRegistry> = {
    [K in keyof TDefs]: TDefs[K] extends TaskDefinition<infer P, infer R, infer S> ? Task<P, R, S> : never;
};
//# sourceMappingURL=task.d.ts.map