# UseDocumentationGeneratorReturn

**Kind:** Interface

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

Hook return type

## Properties

| Property | Type |
|---|---|
| `job` | `DocumentationJob | null` |
| `loading` | `boolean` |
| `error` | `Error | null` |
| `progress` | `number` |
| `currentStage` | `string | null` |
| `stageProgress` | `number` |
| `currentItem` | `string | null` |
| `elapsedMs` | `number` |
| `estimatedRemainingMs` | `number` |
| `isRunning` | `boolean` |
| `isCompleted` | `boolean` |
| `isFailed` | `boolean` |
| `isCancelled` | `boolean` |
| `result` | `JobResult | null` |
| `screenshotProgress` | `{
    batchIndex: number;
    totalBatches: number;
    captured: number;
    totalMappings: number;
  } | null` |
| `startGeneration` | `(options?: { includeScreenshots?: boolean }) => Promise<DocumentationJob>` |
| `cancel` | `() => Promise<void>` |
| `reset` | `() => void` |