Skip to content

useDocumentationGenerator

reference
1 min readUpdated

Kind: Function

Source: atloria-monorepo/apps/web/src/hooks/useDocumentationGenerator.ts

Custom hook for documentation generation

Manages the lifecycle of documentation generation jobs including:

  • Starting new jobs
  • Real-time progress updates via WebSocket
  • Cancellation
  • Error handling

Signature

ts
function useDocumentationGenerator(options: UseDocumentationGeneratorOptions): UseDocumentationGeneratorReturn

Parameters

NameType
optionsUseDocumentationGeneratorOptions

Returns: UseDocumentationGeneratorReturn

Was this page helpful?

Download as PDF