Entypescripten the job API helpers

src/api/job.js → src/api/job.ts

 import axios from 'axios'
 import { unique } from '.'
+import { Job, UUID } from '@/types'
 
 // List background jobs
-export const listJobs = unique(async () => (await axios.get('/jobs/')).data)
+export const listJobs = unique(async (): Promise<Job[]> => (await axios.get('/jobs/')).data)
 
 // Cancel a pending job or delete a finished/failed job
-export const deleteJob = unique(id => axios.delete(`/jobs/${id}/`))
+export const deleteJob = unique((id: UUID) => axios.delete(`/jobs/${id}/`))

src/types.ts

@@ -348,4 +348,22 @@ export interface Dataset {
   name: string
   description: string
   sets: string[]
-}
\ No newline at end of file
+}
+
+export type JobStatus = 'queued' | 'started' | 'deferred' | 'finished' | 'stopped' | 'scheduled' | 'canceled' | 'failed'
+
+/**
+ * An asynchronous job performed by RQ
+ */
+export interface Job {
+  id: UUID
+  description: string
+  /**
+   * Current progress of the job, between 0 and 1. May not be available for every job.
+   */
+  progress: number | null
+  status: JobStatus
+  enqueued_at: string | null
+  started_at: string | null
+  ended_at: string | null
+}