Options
All
  • Public
  • Public/Protected
  • All
Menu

Class RunAction

Hierarchy

Index

Constructors

constructor

Properties

description

description: string

The description of the Task (default this.name)

frequency

frequency: number

How often to run this Task, in ms. 0 is non-recurring. (default: 0)

middleware

middleware: Array<string>

The Middleware specific to this Task (default: []). Middleware is descibed by the string names of the middleware

name

name: string

The name of the Task

pluginOptions

pluginOptions: Array<string>

Options for the node-resque plugins.

plugins

plugins: Array<string>

Plugins from node-resque to use on this task (default: []). Plugins like QueueLock can be applied

queue

queue: string

The default queue to run this Task on (default: 'default')

reEnqueuePeriodicTaskIfException

reEnqueuePeriodicTaskIfException: boolean

Re-enqueuing a periodic task in the case of an exception. (default: false)

Methods

run

  • run(params: any): Promise<object>

validate

  • validate(): void

Generated using TypeDoc