Class default

This class abstracts away the "emission" of events/signals relating to job statuses via mutations to the database.

Index

Constructors

Methods

getEvents getLogs registerEvents registerLogs

Constructors

constructor

new default(): default
Returns default

Methods

getEvents

getEvents(jobId): Promise<Event[]>
Gets all events associated with a given job ordered in reverse chronological order of creation.
Parameters
- jobId: string
  id of job to request
Returns Promise<Event[]>
list of events
- Defined in src/Emitter.ts:80

getLogs

getLogs(jobId): Promise<Log[]>
Gets all logs associated with a given job in reverse chronological order of creation.
Parameters
- jobId: string
  id of job to request
Returns Promise<Log[]>
list of logs
- Defined in src/Emitter.ts:94

registerEvents

registerEvents(job, type, message): Promise<void>
This function processes a event of a given type for a given job. A message is also associated with the event.
Parameters
- job: Job
  the job the event pertains to
- type: string
  the type of the event -- JOB_INIT | JOB_ENDED | JOB_FAILED
- message: string
  message associated with the event
Returns Promise<void>
- Defined in src/Emitter.ts:18

registerLogs

registerLogs(job, message): Promise<void>
Handles any logs that are made during execution.
Parameters
- job: Job
  job the log pertains to
- message: string
  content of the log
Returns Promise<void>
- Defined in src/Emitter.ts:58

Generated using TypeDoc