Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConfigJob

A job based on config settins.

Hierarchy

  • EventEmitter
    • ConfigJob

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • Initializes a new instance of that class.

    Parameters

    • config: Job

      The config entry.

    • controller: Controller

      The underlying controller.

    Returns ConfigJob

Properties

Protected _CONFIG

_CONFIG: Job

Stores the underlying config entry.

Protected _CONTROLLER

_CONTROLLER: Controller

Stores the underlying controller.

Protected _lastExecution

_lastExecution: Moment.Moment

Stores the timestamp of the last execution.

Protected _scheduler

_scheduler: any

Stores the current job scheduler.

Static defaultMaxListeners

defaultMaxListeners: number

Accessors

config

  • get config(): Job

  • Gets the underlying config entry.

    Returns Job

controller

  • Gets the underlying controller.

    Returns Controller

description

  • get description(): string

  • Gets the description of the underlying job.

    inheritdoc

    Returns string

detail

  • get detail(): string

  • Gets the details for the underlying job.

    inheritdoc

    Returns string

isRunning

  • get isRunning(): boolean

  • Gets if the job is currently running or not.

    Returns boolean

lastExecution

  • get lastExecution(): Moment.Moment

  • Gets the timestamp of the last execution.

    Returns Moment.Moment

name

  • get name(): string

  • Gets the name of the underlying job.

    inheritdoc

    Returns string

Methods

addListener

  • addListener(event: string | symbol, listener: Function)

  • Parameters

    • event: string | symbol
    • listener: Function

dispose

  • dispose(): void

  • Dispose this object.

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): string | symbol

  • Returns string | symbol

getMaxListeners

  • getMaxListeners(): number

  • Returns number

listenerCount

  • listenerCount(type: string | symbol): number

  • Parameters

    • type: string | symbol

    Returns number

listeners

  • listeners(event: string | symbol): Function[]

  • Parameters

    • event: string | symbol

    Returns Function[]

on

  • on(event: string | symbol, listener: Function)

  • Parameters

    • event: string | symbol
    • listener: Function

once

  • once(event: string | symbol, listener: Function)

  • Parameters

    • event: string | symbol
    • listener: Function

prependListener

  • prependListener(event: string | symbol, listener: Function)

  • Parameters

    • event: string | symbol
    • listener: Function

prependOnceListener

  • prependOnceListener(event: string | symbol, listener: Function)

  • Parameters

    • event: string | symbol
    • listener: Function

removeAllListeners

  • removeAllListeners(event?: string | symbol)

  • Parameters

    • Optional event: string | symbol

removeListener

  • removeListener(event: string | symbol, listener: Function)

  • Parameters

    • event: string | symbol
    • listener: Function

setMaxListeners

  • setMaxListeners(n: number)

  • Parameters

    • n: number

start

  • start(): Thenable<boolean>

  • Starts the job.

    Returns Thenable<boolean>

    The promise.

Protected startSync

  • startSync(): boolean

  • Starts the job.

    Returns boolean

    Job has been started or not.

stop

  • stop(): Thenable<boolean>

  • Stops the job.

    Returns Thenable<boolean>

    The promise.

Protected stopSync

  • stopSync(): boolean

  • Stops the job.

    Returns boolean

    Job has been stopped or not.

Static listenerCount

  • listenerCount(emitter: EventEmitter, event: string | symbol): number

  • Parameters

    • emitter: EventEmitter
    • event: string | symbol

    Returns number

Generated using TypeDoc