Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface JobScheduler

A job scheduler.

Hierarchy

  • Disposable
    • JobScheduler

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

  • Creates a new Disposable calling the provided function on dispose.

    Parameters

    • callOnDispose: Function

      Function that disposes something.

    Returns JobScheduler

Properties

description

description: string

Gets the description of the underlying job.

detail

detail: string

Gets the details for the underlying job.

isRunning

isRunning: boolean

Gets if the scheduler is running or not.

lastExecution

lastExecution: Moment.Moment

Gets the timestamp of the last execution.

name

name: string

Gets the name of the underlying job.

start

start: function

Starts the scheduler.

returns

The promise.

Type declaration

    • (): Thenable<boolean>

    • Returns Thenable<boolean>

stop

stop: function

Stops the scheduler.

returns

The promise.

Type declaration

    • (): Thenable<boolean>

    • Returns Thenable<boolean>

Methods

dispose

  • dispose(): any

  • Dispose this object.

    Returns any

Static from

  • from(...disposableLikes: object[]): Disposable

  • Combine many disposable-likes into one. Use this method when having objects with a dispose function which are not instances of Disposable.

    Parameters

    • Rest ...disposableLikes: object[]

      Objects that have at least a dispose-function member.

      • dispose: function
          • (): any

          • Returns any

    Returns Disposable

    Returns a new disposable which, upon dispose, will dispose all provided disposables.

Generated using TypeDoc