Handle

Handle

handle running jobs

Constructor

new Handle()

Description:
  • constructor

Source:

Members

ipc

Description:
  • get ipc

Source:

get ipc

Methods

cancel(name, data) → {Job}

Description:
  • Cancel job if any exists

Source:
Parameters:
Name Type Description
name string

job name

data object

data about job

Returns:

job

Type
Job

job(name, data) → {Job}

Description:
  • create job instance

Source:
Parameters:
Name Type Description
name string

job name

data object

data about job

Returns:

job

Type
Job

runTransient(name, data) → {Promise}

Description:
  • run transient job

Source:
Parameters:
Name Type Description
name string

job name

data object

data about job

Returns:

promise

Type
Promise

(async) suspendJob(params) → {object}

Description:
  • Suspend a job from UI

Source:
Parameters:
Name Type Description
params object

params object with job id

Returns:
  • result of the operation
Type
object