# UseDocumentationJobsReturn

**Kind:** Interface

**Source:** [`atloria-monorepo/apps/web/src/hooks/useDocumentationJobs.ts`](https://github.com/sherkety/atloria/blob/main/atloria-monorepo/apps/web/src/hooks/useDocumentationJobs.ts#L52)

Hook return type

## Properties

| Property | Type |
|---|---|
| `jobs` | `DocumentationJobEntry[]` |
| `total` | `number` |
| `loading` | `boolean` |
| `error` | `Error | null` |
| `liveProgress` | `Record<string, LiveJobProgress>` |
| `refresh` | `() => Promise<void>` |
| `startRegeneration` | `(projectId: string) => Promise<DocumentationJob>` |
| `cancelJob` | `(jobId: string) => Promise<void>` |
| `deleteJobDocuments` | `(jobId: string) => Promise<void>` |