Kind: Interface
Source: atloria-monorepo/apps/web/src/hooks/useDocumentationGenerator.ts
Hook return type
Properties
| Property | Type |
|---|---|
job | `DocumentationJob |
loading | boolean |
error | `Error |
progress | number |
currentStage | `string |
stageProgress | number |
currentItem | `string |
elapsedMs | number |
estimatedRemainingMs | number |
isRunning | boolean |
isCompleted | boolean |
isFailed | boolean |
isCancelled | boolean |
result | `JobResult |
screenshotProgress | `{ |
batchIndex: number; totalBatches: number; captured: number; totalMappings: number;
} | null| |startGeneration|(options?: { includeScreenshots?: boolean }) => Promise| |cancel|() => Promise| |reset|() => void` |
Was this page helpful?