actionhero/dist/classes/task.d.ts

The reusable, scalable, and quick node.js API server for stateless and stateful applications

import { Inputs } from "./inputs";
import { Plugin, Worker } from "node-resque";
/**
 * Create a new Actionhero Task. The required properties of an task. These can be defined statically (this.name) or as methods which return a value.
 * ```js
 * import { Task, api, log } from "actionhero"
 *
 * export default class SayHello extends Task {
 *  constructor () {
 *   super()
 *    this.name = 'sayHello'
 *    this.description = 'I say Hello every minute'
 *    this.frequency = (60 * 1000)
 *  }
 *  async run (data, worker) {
 *    log('Hello!')
 *  }
 * }
 * ```
 */
export declare abstract class Task {
    /**The name of the Task */
    name: string;
    /**The description of the Task (default this.name) */
    description: string;
    /**The default queue to run this Task on (default: 'default') */
    queue: string;
    /**How often to run this Task, in ms.  0 is non-recurring. (default: 0) */
    frequency?: number;
    /**The inputs of the Task (default: {}) */
    inputs?: Inputs;
    /**The Middleware specific to this Task (default: []).  Middleware is described by the string names of the middleware */
    middleware?: Array<string>;
    /**Plugins from node-resque to use on this task (default: []).  Plugins like `QueueLock can be applied` */
    plugins?: Array<string | (new (args: ConstructorParameters<typeof Plugin>) => Plugin)>;
    /**Options for the node-resque plugins. */
    pluginOptions?: {
        [key: string]: any;
    };
    /**Re-enqueuing a periodic task in the case of an exception.  (default: false) */
    reEnqueuePeriodicTaskIfException?: boolean;
    constructor();
    /**
     * The main "do something" method for this task.  It can be `async`.  Anything returned from this method will be logged.
     * If error is thrown in this method, it will be logged & caught.  Using middleware, you can decide to re-run the task on failure.
     * `this` is a Task instance itself now.
     *
     * Inputs:
     * * data: The data about this instance of the task, specifically params.
     * * worker: Instance of a node-resque worker. You can inspect `worker.job` and set `worker.result` explicitly if your Task does not return a value.
     */
    abstract run(data: TaskInputs, worker: Worker): Promise<any>;
    validate?(): void;
}
export interface TaskInputs {
    [key: string]: any;
}