Class Tasks

Hierarchy

Tasks

Index

Constructors

constructor

Methods

Constructors

constructor

new Tasks(socket: any): Tasks

- Defined in tasks.ts:49
Parameters
- socket: any
Returns Tasks

Methods

close

close(uid: string, callback?: (error: Error) => void): Promise<void>

- Defined in tasks.ts:79
Close a terminated task from the list of tasks.

Parameters
- uid: string
  
  the task's unique ID
- Optional callback: (error: Error) => void
  
  the callback function
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns Promise<void>

list

list(callback?: (error: Error, outcome: TaskOutcome) => void): Promise<TaskOutcome>

- Defined in tasks.ts:59
Obtain information about Dicoogle's running (or terminated) tasks.

Parameters
- Optional callback: (error: Error, outcome: TaskOutcome) => void
  
  the callback function
  - - (error: Error, outcome: TaskOutcome): void
    - Parameters
      - error: Error
      - outcome: TaskOutcome
      Returns void
Returns Promise<TaskOutcome>

stop

stop(uid: string, callback?: (error: Error) => void): Promise<void>

- Defined in tasks.ts:92
Request that a task is stopped.

Parameters
- uid: string
  
  the task's unique ID
- Optional callback: (error: Error) => void
  
  the callback function
  - - (error: Error): void
    - Parameters
      - error: Error
      Returns void
Returns Promise<void>

Generated using TypeDoc