Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface GlobalJob

A global job.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

  • new GlobalJob(callOnDispose: Function): GlobalJob

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

    Parameters

    • callOnDispose: Function

      Function that disposes something.

    Returns GlobalJob

Properties

description

description: string

A description for the job.

isRunning

isRunning: boolean

Gets if the job is currently running or not.

name

name: string

The (display) name.

start

start: function

Starts the job.

returns

Operation was successful or not.

Type declaration

    • (): boolean

    • Returns boolean

stop

stop: function

Stops the job.

returns

Operation was successful or not.

Type declaration

    • (): boolean

    • Returns 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.

    Returns Disposable

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

Generated using TypeDoc